Deployment API
To support a Continuous Integration or Deployment (CI/CD) workflow, you can access the DXP Management Portal deployment functionality through an API.
The API is exposed as a REST API and consists of the following functionalities:
- Deployment – Start, complete, and reset deployments to individual environments.
- Content synchronization – Synchronize databases and BLOBs from Production to other environments, such as Preproduction or Integration.
- Export – Export databases of various DXP environments in bacpac format and download to use them as needed.
- Storage containers – List available BLOB storage containers in a DXP environment and generate a read-only SAS link with dynamic retention hours to access the contents of the container.
The PowerShell module wraps the integration functionality with a CI/CD pipeline.
See Azure DevOps and Optimizely deployment API for instructions on how to integrate Azure DevOps with the DXP Management Portal.
See Octopus Deploy and Optimizely's deployment API - Quickstart guide for instructions on how to integrate Octopus Deploy with the DXP Management Portal.
You can use Deployment API to start a code deployment between DXP environments in the following ways:
- Deploy using code packagesDeploy using code packages
- Deploy using the code from a source environmentDeploy using the code from a source environment
Deployment API limitations
Deploy using code packages
- You cannot include BLOB and DB packages while deploying through code packages.
- When you deploy the code package directly to the Integration environment using Deployment API, you cannot complete or reset the deployment using the DXP management portal. However, you can get the API verification link and complete or reset the deployment to Integration.
Deploy using source environment
- You cannot deploy code from the Integration environment to Production.
- You cannot have the Custom maintenance pageCustom maintenance page displayed for content-only deployments (that is, copying BLOB/DB from the source environment) without code.
📘 Note The deployment API allows code deployment only using code packages or source environment, but not both at once. Also, the get deployment list API action fetches the top 10 recent deployments.