Deployment API
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.
Deploy using code packages
Deploying a code package is recommended for using the Deployment API . This workflow can also be used to do an urgent hotfix deployment to the production environment without going through the entire workflow of promoting the release through preproduction.
Deploy using source environment
This functionality is similar to the deployments done through DXP management portal . You can copy a BLOB/DB from a source environment to target by deploying this approach.
Deploy using PowerShell
To simplify usage of the Deployment API, a PowerShell module EpiCloud https //www. powershellgallery.
Create code packages
The first step to using the API is to bundle your web application into a code package. Use the following conventions when you name a code package (a package containing Web App binaries, configuration, and so on).
Internal namespaces
One of the primary considerations when building a software platform on which other developers base their work is maintaining backward compatibility. As the platform grows more complex, this can become a major restraining factor when sustaining a high development pace.
Authenticate with Deployment API
The Deployment API for Optimizely Digital Experience Platform (DXP) authenticates each user request using a pair of client keys and a client secret. You can create one or more credentials with the self-service option in the DXP management portal and associate them with DXP environments.
Work with BLOB storage containers
Storage accounts are provisioned as part of a DXP project and are used for various purposes (for example, access logs or to download site contents). The storage container API allows access to the BLOB storage containers and contents.
Export and import database
You can export the Optimizely Content Management System (CMS) or Optimizely Customized Commerce database to a bacpac file using the API or using the PaaS portal. When you export a database, it triggers an export job for the requested database.
Access Application Insights API to query telemetry
Application Insights API Access lets you query telemetry from Application Insights for a specific environment. Go to your project in the DXP portal and select the API tab.