Frequently asked questions
How do I authenticate API requests?
To authenticate Deployment API requests in Mage Pro:
Include an OAuth token in the request header
Provide an API key in the deployment payload
This two-factor authentication ensures secure and authorized access to Mage Pro APIs, including the Deployment API. Learn more.
What can I do with the Deployment API?
Deploy code and pipeline changes to various environments
Automate release workflows (CI/CD)
Specify version, branch, environment, and deployment directory
Integrate Mage Pro with your existing DevOps pipelines
What information is needed to create a deployment?
To create a deployment using the API, you need:
Deployment setting name
Source branch and commit version
Target environment (dev, staging, prod)
Deployment directory (path)
OAuth authentication token and API key
What is the Mage Pro Deployment API?
The Mage Pro Deployment API enables you to programmatically create deployments in your Mage Pro environments, automating the release and update of your code and pipelines across development, staging, and production environments. Learn more.