HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Deployment API

Describes how to use the deployment API to support a continuous integration/deployment workflow as part of the Optimizely Digital Experience Platform (DXP).

To support a Continuous Integration/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.  To start, complete, and reset deployments to individual environments.
  • Content synchronization. Synchronize databases and/or BLOBs from Production down 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 also generate a read-only SAS link with dynamic retention hours to access the contents of the container.

The PowerShell module wraps the functionality to integrate with a CI/CD pipeline.

See Azure DevOps and Optimizely deployment API for how to integrate Azure DevOps with the DXP Management Portal.

See Octopus Deploy and Optimizely's deployment API - Quickstart guide for 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: