start_deployment
Initiate code, content, or full deployments between Optimizely DXP environments. Configure source and target environments, choose deployment type, and manage Commerce-specific options for CMS or Commerce apps.
Instructions
Start deployment between environments. Smart defaults: Upward (Int→Pre, Pre→Prod) deploys CODE; Downward (Prod→Pre/Int) copies CONTENT. Override with deploymentType: "code", "content", or "all". Commerce: set sourceApps: ["cms", "commerce"]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | No | ||
| apiSecret | No | ||
| deploymentType | No | ||
| directDeploy | No | ||
| includeBlob | No | ||
| includeDatabase | No | ||
| projectId | No | ||
| projectName | No | ||
| sourceApps | No | ||
| sourceEnvironment | Yes | ||
| targetEnvironment | Yes | ||
| useMaintenancePage | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
},
"apiSecret": {
"type": "string"
},
"deploymentType": {
"enum": [
"code",
"content",
"all"
],
"type": "string"
},
"directDeploy": {
"default": false,
"type": "boolean"
},
"includeBlob": {
"type": "boolean"
},
"includeDatabase": {
"type": "boolean"
},
"projectId": {
"type": "string"
},
"projectName": {
"type": "string"
},
"sourceApps": {
"items": {
"type": "string"
},
"type": "array"
},
"sourceEnvironment": {
"enum": [
"Integration",
"Preproduction",
"Production"
],
"type": "string"
},
"targetEnvironment": {
"enum": [
"Integration",
"Preproduction",
"Production"
],
"type": "string"
},
"useMaintenancePage": {
"default": false,
"type": "boolean"
}
},
"required": [
"sourceEnvironment",
"targetEnvironment"
],
"type": "object"
}