Deployments
Deployment represents the hosted application/integration which is managed by clients.
Deployment contains a reference to a Connector, which is built and deployed on the specified Region.
Clients can provide additional configuration values for specific Connectors which act as environment variables for their specific deployment.
Representations
Deployment
id String | Unique identifier of the Deployment. |
version Int | Current version of the Deployment. |
key String | User-defined unique identifier of the Deployment. MinLength:2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
connector | Details of the Connector being deployed. |
details | Build reference id and outcome of the Deployment. |
deployedRegion | Region of the Deployment. |
applications Array of ApplicationDeployment | Application deployments needed by the connector for hosting and configuration, refer to Connector configurations for details. |
preview Boolean | If |
status | The current status of the Deployment. |
DeploymentDraft
key String | User-defined unique identifier for the Deployment. MinLength:2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
connector | Reference to the Connector being deployed. |
configurations Array of DeploymentConfigurationApplication | Configuration values needed by the Connector for hosting. Keys should match those in the Connector's |
region | Region of Deployment. |
{"key": "key-for-my-deployment","connector": {"key": "connector-key","version": 1},"configurations": [{"applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}]}],"region": "europe-west1.gcp"}
DeploymentConnector
The details of the deployed Connector.
id String |
|
version Int | Version of the Connector. |
key String | User-defined unique identifier of the Connector. |
name String | Name of the Connector. |
description String | Description of the Connector. |
creator | Owner of the Connector. |
repository | Details of the GitHub repository that contains the Connect applications. |
certified Boolean | If |
{"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true}
DeploymentCreator
The details of the deployed DeploymentConnector creator.
name String | Name of the person who owns the Connector. |
title String | Title of the person who owns the Connector. |
email String | Contact email address of the creator. |
company String | Name of the company that owns the Connector. |
noOfContributors Int | Number of contributors currently working for the company. |
{"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200}
DeploymentDetails
Additional details about the deployed Connector.
build | The build details of deployed applications. |
DeploymentDetailsBuild
id String | The build execution id of the deployed application. |
report | The build report of the deployed Connector. |
{"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}
DeploymentReport
Describes a report of the Connector deployment process.
entries Array of DeploymentReportEntry | Contains informations, errors and warnings about the Connector deployment. |
DeploymentReportEntry
Describes an information, error, or warning in the deployment report.
The report entry type. | |
title String | The title of the report entry. |
message String | The message related to the report entry. |
application String | The name of the Connect application related to the entry. |
createdAt | When the report entry was created. |
DeploymentReportEntryType
The type of message being reported.
Information
Indicates information returned during the deployment process.
Warning
Indicates an issue that arose during the deployment process.
Error
Indicates a crash or failure to complete the deployment process.
DeploymentConfigurationApplication
Describes the configuration set of a given application.
applicationName String | Name of the application. Should match the value of |
standardConfiguration Array of ConfigurationValue | Contains values of keys that are saved in plain text. Can be accessed after being set. |
securedConfiguration Array of ConfigurationValue | Contains values of secret keys. Cannot be accessed after being set. |
ApplicationDeployment
Describes an application deployment of the Connector.
id String | Unique identifier of the application deployment. |
applicationName String | Name of the application. Should match the value of |
standardConfiguration Array of ConfigurationValue | Contains values of keys that are saved in plain text. Can be accessed after being set. |
securedConfiguration Array of ConfigurationValue | Contains values of secret keys. Cannot be accessed after being set. |
url String | URL generated after deployment of service applications. |
topic String | Pub/Sub Topic generated after deployment of event applications. |
schedule String | Cron schedule for job applications. |
{"id": "e478afb6-dd35-4f3d-a460-6f5f97988ebb","applicationName": "app-3","standardConfiguration": [{"key": "CONFIG_KEY","value": "config key value"}],"securedConfiguration": [{"key": "CONFIG_SECRET","value": "config secret value"}],"schedule": "* * * * 5"}
ConfigurationValue
key String | Name of the environment variable. |
value String | Value of the environment variable. |
{"key": "CONFIG_KEY","value": "config key value"}
DeploymentStatus
Indicates the current status of the Deployment.
Draft
Queued
The Deployment is in a queue waiting to be processed.
Deploying
The deployment process has started.
Deployed
The Deployment is live.
Failed
The deployment process failed.
Undeploying
The Deployment is being undeployed.
UndeployFailed
The process to undeploy failed.
Get Deployment
Get Deployment by ID
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey} ,
view_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
id String |
|
application/json
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/{id} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}'
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}
Get Deployment by Key
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey} ,
view_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
key String |
|
application/json
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}'
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}
Query Deployments
Retrieves all deployments of a project key.
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey} ,
view_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
limit Int | Number of results requested. |
offset Int | Number of elements skipped. |
sort String | The parameter can be passed multiple times. |
Paged
asapplication/json
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments -i \--header 'Authorization: Bearer ${BEARER_TOKEN}'
{"offset": 0,"limit": 20,"total": 1,"count": 1,"results": [{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-3","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"schedule": "* * * * 5"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}]}
Create Deployment
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
application/json
application/json
curl https://connect.{region}.commercetools.com/{projectKey}/deployments -i \--header 'Authorization: Bearer ${BEARER_TOKEN}' \--header 'Content-Type: application/json' \--data-binary @- << DATA{"key" : "deployment-key","connector" : {"id" : "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","version" : 1},"region" : "europe-west1.gcp","configurations" : [ {"applicationName" : "app-1","standardConfiguration" : [ {"key" : "CONFIG_KEY","value" : "config-key-value"} ],"securedConfiguration" : [ {"key" : "CONFIG_SECRET_KEY","value" : "config-secret-key-value"} ]} ]}DATA
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}
Update Deployment
Update Deployment by ID
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
id String |
|
application/json
version Int | Expected version of the Deployment on which the changes apply. |
actions Array of DeploymentUpdateAction | Update actions to be performed on the Deployment. |
application/json
curl https://connect.{region}.commercetools.com/{projectKey}/deployments/{id} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}' \--header 'Content-Type: application/json' \--data-binary @- << DATA{"version" : 1,"actions" : [ {"action" : "redeploy","configurationValues" : [ {"applicationName" : "app-1","standardConfiguration" : [ {"key" : "CONFIG_KEY","value" : "config-key-value"} ],"securedConfiguration" : [ {"key" : "CONFIG_SECRET_KEY","value" : "config-secret-key-value"} ]} ]} ]}DATA
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}
Update Deployment by Key
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
key String |
|
application/json
version Int | Expected version of the Deployment on which the changes apply. |
actions Array of DeploymentUpdateAction | Update actions to be performed on the Deployment. |
application/json
curl https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}' \--header 'Content-Type: application/json' \--data-binary @- << DATA{"version" : 1,"actions" : [ {"action" : "redeploy","configurationValues" : [ {"applicationName" : "app-1","standardConfiguration" : [ {"key" : "CONFIG_KEY","value" : "config-key-value"} ],"securedConfiguration" : [ {"key" : "CONFIG_SECRET_KEY","value" : "config-secret-key-value"} ]} ]} ]}DATA
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}
Update actions
Redeploy
Update the configuration values and redeploy the Deployment.
Attempting to redeploy a Deployment that does not require configuration or a configuration key for an application returns the DeploymentUnknownApplicationConfiguration or DeploymentUnknownApplicationConfigurationKey errors, respectively.
Attempting to redeploy a Deployment with a Queued
, Deploying
, or Undeploying
DeploymentStatus returns a DeploymentInvalidStatusTransition error.
action String | "redeploy" |
skipScripts Boolean | If scripts execution should be skipped during deployment. Default:false |
configurationValues Array of DeploymentConfigurationApplication | New configuration values for Deployment. If empty, any existing value is unchanged. |
{"action": "redeploy","configurationValues": [{"applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}]}]}
Delete Deployment
Delete Deployment by ID
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
id String |
|
application/json
202Deploymentasapplication/json
curl -X DELETE https://connect.{region}.commercetools.com/{projectKey}/deployments/{id} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}'
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}
Delete Deployment by Key
manage_project:{projectKey} ,
manage_connectors_deployments:{projectKey}
region String | Region in which the Project is hosted. |
projectKey String | The Composable Commerce Project key. |
key String |
|
application/json
202Deploymentasapplication/json
curl -X DELETE https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key} -i \--header 'Authorization: Bearer ${BEARER_TOKEN}'
{"id": "13c72c44-7a8e-44f2-a570-b5e991f7021a","key": "deployment-key","version": 1,"connector": {"id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5","key": "connector-key","version": 1,"name": "Connectors name","description": "Connectors description","creator": {"title": "Mr","name": "John Doe","email": "john.doe@example.com","company": "commercetools","noOfContributors": 200},"repository": {"url": "git@github.com:commercetools/connect-application-kit.git","tag": "0.0.0"},"certified": true},"details": {"build": {"id": "a317ce94-5149-45ec-8717-d1c05b49005a","report": {"entries": [{"type": "Warning","application": "service","title": "Failed during the execution of 'postDeploy' script","createdAt": "2023-08-08T17:00:59.327Z"}]}}},"applications": [{"id": "c9c3b342-c2ca-11ed-afa1-0242ac120002","applicationName": "app-1","standardConfiguration": [{"key": "CONFIG_KEY","value": "config-key-value"}],"securedConfiguration": [{"key": "CONFIG_SECRET_KEY","value": "config-secret-key-value"}],"url": "app1.commercetools.app"}],"deployedRegion": "europe-west1.gcp","preview": true,"status": "Deployed"}