Skip to main content

Managing Environments

All DX Engine elements (Secrets, Connections, Components) are scoped to an environment. This means that a Secret, Connection, or Component can only be used within the environment it was created in. This allows you to create multiple environments for different purposes (development, staging, production, etc.) and to use the same names for Secrets, Connections, and Components across environments. Typically, Secrets (which are used by Connections) are created for each Environment while Connections and Components are created in a development environment and then exported to other environments.

Environment Management API

Create an Environment

POST {{engineUrl}}/experience/environments
X-Customer-Code: {{customerCode}}
Authorization: Bearer {{dxEngineToken}}

{
"environmentCode": "test",
"name": "Testing",
"description": "My Testing Environment description"
}

Update an Environment

PUT {{engineUrl}}/experience/environments/{{environmentCode}}
X-Customer-Code: {{customerCode}}
Authorization: Bearer {{dxEngineToken}}

{
"name": "New Testing name",
"description": "My Testing Environment description"
}

List availableEnvironments

GET {{engineUrl}}/environments
X-Customer-Code: {{customerCode}}
Authorization: Bearer {{dxEngineToken}}

Remove an Environment

DELETE {{engineUrl}}/environments/{{environmentCode}}
X-Customer-Code: {{customerCode}}
Authorization: Bearer {{dxEngineToken}}

Exporting Configurations of an Environment

All DX Engine configurations within an environment can be exported as a JSON file via an API call, which you can then version control. This can then be used to restore an environment via another API endpoint.

Detailed Documentation Coming Soon

Restoring an Environment

Detailed Documentation Coming Soon