Deployments

Deployment represents the hosted application/integration which is managed by clients.

Deployment contains a reference to a Connector, which is built and deployed in the specified Region.

Clients can provide additional configuration values for specific Connectors which act as environment variables for their specific deployment.

Connectors that use third-party services may require that you have a commercial contract with the service provider before deploying the Connector.

Representations

Deployment

DeploymentDraft

DeploymentPagedQueryResponse

DeploymentConnector

DeploymentCreator

DeploymentDetails

DeploymentDetailsBuild

DeploymentReport

DeploymentReportEntry

DeploymentReportEntryType

DeploymentConfigurationApplication

ApplicationDeployment

ConfigurationValue

DeploymentStatus

DeploymentType

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_-]+$`
`type` DeploymentType	Deployment type. If a ConnectorStaged is referenced in the `connector` field, then the field can only be `preview`. If a Connector is referenced in the `connector` field, then the field can either be `sandbox` or `production`.
`connector` DeploymentConnector	Details of the Connector being deployed.
`globalConfiguration` DeploymentGlobalConfiguration	Global configuration applied to all applications in the deployment.
`apiClient` DeploymentApiClient	API Client credentials used for deployment.
`details` DeploymentDetails	Build reference id and outcome of the Deployment.
`deployedRegion` Region	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 `true`, the Deployment is a preview.
`status` DeploymentStatus	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_-]+$`
`type` DeploymentType	Deployment type. If a ConnectorStaged is referenced in the `connector` field, you can send only `preview`. If a Connector is referenced in the `connector` field, the value defaults to `sandbox`. However, you can send `production` when you are ready to deploy the Connector to your production environment.
`connector` ConnectorReference	Reference to the Connector or ConnectorStaged being deployed.
`configurations` Array of DeploymentConfigurationApplication	Configuration values needed by the Connector for hosting. Keys should match those in the Connector's `configurations` field.
`globalConfiguration` DeploymentGlobalConfiguration	Global configuration values needed by the Connector for hosting. Keys should match those in the Connector's `globalConfiguration` field.
`region` Region	Region of Deployment.

Example: json

{
  "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"
}

DeploymentPagedQueryResponse

PagedQueryResult with results containing an array of Deployment.

`limit` Int	The limit of the Deployments returned.
`offset` Int	The offset of the Deployments returned.
`count` Int	The number of Deployments returned.
`total` Int	The total number of Deployments available.
`results` Array of Deployment	Deployments matching the query.

DeploymentConnector

The details of the deployed Connector.

`id` String	`id` of the Connector.
`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.
`integrationTypes` Array of IntegrationType	Connector integration type list.
`creator` DeploymentCreator	Owner of the Connector.
`repository` Repository	Details of the GitHub repository that contains the Connect applications.
`configurations` Array of ConnectorConfigurationApplication	Configurations needed by Connectors for hosting. Loaded as environment variables in the application.
`globalConfiguration` ConnectorGlobalConfiguration	Global configuration applied to all applications in the deployment.
`certified` Boolean	If `true`, the Connector is certified.
`supportedRegions` Array of Region	If not empty, Connectors can only be deployed in these Regions. If empty, Connectors can be deployed in any supported Region.
`documentationUrl` String	URL to the documentation of the Connector.

Example: json

{
  "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
  "key": "connector-key",
  "version": 1,
  "name": "Connectors name",
  "description": "Connectors description",
  "integrationTypes": [
    "other"
  ],
  "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.
`logoUrl` String	URL to an image used as the company logo.
`supportUrl` String	Url to support website of the company.

Example: json

{
  "title": "Mr",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "company": "commercetools",
  "noOfContributors": 200
}

DeploymentDetails

Additional details about the deployed Connector.

build

DeploymentDetailsBuild

The build details of deployed applications.

DeploymentDetailsBuild

`id` String	The build execution id of the deployed application.
`report` DeploymentReport	The build report of the deployed Connector.

Example: json

{
  "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 information, errors and warnings about the Connector deployment.

DeploymentReportEntry

Describes an information, error, or warning in the deployment report.

`type` DeploymentReportEntryType	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` DateTime	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 `name` within the connect.yaml file of the Connect application.
`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 `name` within the connect.yaml file of the Connector. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`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. After being set, these values are encrypted and cannot be accessed.
`url` String	URL generated after deployment of service applications.
`topic` String	Google Cloud Pub/Sub Topic generated after deployment of event applications.
`schedule` String	Cron schedule for job applications.

Example: json

{
  "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.

Example: json

{
  "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.

DeploymentType

Deployment type of the Connector.

preview: The deployed Connector is the previewable ConnectorStaged.
sandbox: The Connector is deployed in the sandbox environment.
production: The Connector is deployed in the production environment and requires a commercetools Composable Commerce Project that is also marked as in production.

Get Deployment

Get Deployment by ID

GET

https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`id` String	`id` of the Deployment
`region` String	Region in which the Project is hosted.

Response:

200

Deployment

asapplication/json

Request Example:cURL

curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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

GET

https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`key` String	`key` of the Deployment
`region` String	Region in which the Project is hosted.

Response:

200

Deployment

asapplication/json

Request Example:cURL

curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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

GET

https://connect.{region}.commercetools.com/{projectKey}/deployments

Retrieves all deployments of a project key.

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`region` String	Region in which the Project is hosted.

Query parameters:

`limit` Int	Number of results requested. Default: `20` Minimum: `0` Maximum: `500`
`offset` Int	Number of elements skipped. Default: `0` Maximum: `10000`
`sort` String	The parameter can be passed multiple times.
`integrationTypes` IntegrationType	Filter the results by the `integrationType` of a Connector. The parameter can be passed multiple times.
`deploymentType` DeploymentType	Filter the results by the `deploymentType` of a Connector.

Response:

200

DeploymentPagedQueryResponse

asapplication/json

Request Example:cURL

curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: DeploymentPagedQueryResponsejson

{
  "offset": 0,
  "limit": 20,
  "total": 1,
  "count": 1,
  "results": [
    {
      "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
      "key": "deployment-key",
      "version": 1,
      "type": "preview",
      "connector": {
        "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
        "key": "connector-key",
        "version": 1,
        "name": "Connectors name",
        "description": "Connectors description",
        "integrationTypes": ["other"],
        "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

POST

https://connect.{region}.commercetools.com/{projectKey}/deployments

Specific Error Codes:

The manage_api_clients:{projectKey} scope is required if you use automatically generated API Client credentials.

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`region` String	Region in which the Project is hosted.

Request Body:DeploymentDraftasapplication/json

Response:

201

Deployment

asapplication/json

Request Example:cURL

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

201 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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

POST

https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`id` String	`id` of the Deployment
`region` String	Region in which the Project is hosted.

Request Body:

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.

Response:

201

Deployment

asapplication/json

Request Example:cURL

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

201 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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

POST

https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`key` String	`key` of the Deployment
`region` String	Region in which the Project is hosted.

Request Body:

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.

Response:

201

Deployment

asapplication/json

Request Example:cURL

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

201 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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

Updates configuration values and redeploys a Deployment in Draft, Deployed, Failed, or UndeployFailed states. The new configuration values must include at least one valid application. Ensure that all deployment configuration keys and values match those specified in the application's connect.yaml file.

Specific error codes:

`action` String	`"redeploy"`
`skipScripts` Boolean	Whether the scripts execution should be skipped during redeployment. Default: `false`
`configurationValues` Array of DeploymentConfigurationApplication	New configuration values for Deployment. If empty, any existing value is unchanged.
`updateConnector` Boolean	Whether the Deployment Connector should be updated to its latest state during redeployment. Default: `false`

Example: json

{
  "action": "redeploy",
  "skipScripts": true,
  "configurationValues": [
    {
      "applicationName": "app-1",
      "standardConfiguration": [
        {
          "key": "CONFIG_KEY",
          "value": "config-key-value"
        }
      ],
      "securedConfiguration": [
        {
          "key": "CONFIG_SECRET_KEY",
          "value": "config-secret-key-value"
        }
      ]
    }
  ],
  "updateConnector": true
}

Delete Deployment

Delete Deployment by ID

DELETE

https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`id` String	`id` of the Deployment
`region` String	Region in which the Project is hosted.

Response:

200

Deployment

asapplication/json202

Deployment

asapplication/json

Request Example:cURL

curl -X DELETE https://connect.{region}.commercetools.com/{projectKey}/deployments/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

202 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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

DELETE

https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}

OAuth 2.0 Scopes:

manage_project:{projectKey}manage_connectors_deployments:{projectKey}

Path parameters:

`projectKey` String	The Composable Commerce Project key.
`key` String	`key` of the Deployment
`region` String	Region in which the Project is hosted.

Response:

200

Deployment

asapplication/json202

Deployment

asapplication/json

Request Example:cURL

curl -X DELETE https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

202 Response Example: Deploymentjson

{
  "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
  "key": "deployment-key",
  "version": 1,
  "type": "preview",
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "key": "connector-key",
    "version": 1,
    "name": "Connectors name",
    "description": "Connectors description",
    "integrationTypes": ["other"],
    "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"
}

Deployments

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Deployment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentPagedQueryResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentConnector.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentCreator.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentDetails.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentDetailsBuild.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentReport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentReportEntry.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentReportEntryType.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentConfigurationApplication.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ApplicationDeployment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ConfigurationValue.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentStatus.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeploymentType.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Get Deployment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Get Deployment by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Get Deployment by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Query Deployments.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Create Deployment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update Deployment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update Deployment by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update Deployment by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update actions.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Redeploy.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Delete Deployment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Delete Deployment by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Delete Deployment by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Representations

Deployment

DeploymentDraft

DeploymentPagedQueryResponse

DeploymentConnector

DeploymentCreator

DeploymentDetails

DeploymentDetailsBuild

DeploymentReport

DeploymentReportEntry

DeploymentReportEntryType

DeploymentConfigurationApplication

ApplicationDeployment

ConfigurationValue

DeploymentStatus

DeploymentType

Get Deployment

Get Deployment by ID

Get Deployment by Key

Query Deployments

Create Deployment

Update Deployment

Update Deployment by ID

Update Deployment by Key

Update actions

Redeploy

Delete Deployment

Delete Deployment by ID

Delete Deployment by Key