Deployment Revisions

Connect Add-On

Deployment revisions represent previous configurations of a Deployment.

Deployment revisions are created automatically for every successful Deployment and can be used to inspect earlier configurations or roll back a Deployment to a previous version.

Get DeploymentRevision

Get DeploymentRevision by Deployment ID

GET
https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}/revisions/{revision}
OAuth 2.0 Scopes:
manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}
Path parameters:
projectKey
​
String
​

The commercetools Project key.

id
​
String
​
id of the Deployment
revision
​
Int64
​
revisionNumber of the DeploymentRevision.
Minimum: 1​
region
​
String
​
Region in which the Project is hosted.
Response:
200

DeploymentRevision

as
application/json
Request Example:cURL
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}/revisions/{revision} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
200 Response Example: DeploymentRevisionjson
{
  "revisionNumber": 7,
  "currentRevision": false,
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "version": 1,
    "repository": {
      "url": "git@github.com:commercetools/connect-application-kit.git",
      "tag": "0.0.0"
    }
  },
  "globalConfiguration": {
    "standardConfiguration": [
      {
        "key": "GLOBAL_CONFIG_KEY",
        "value": "global config key value"
      }
    ],
    "securedConfiguration": []
  },
  "applications": [
    {
      "applicationName": "event-application",
      "standardConfiguration": [
        {
          "key": "CONFIG_KEY",
          "value": "config key value"
        }
      ],
      "securedConfiguration": [
        {
          "key": "CONFIG_SECRET",
          "value": "********"
        }
      ]
    }
  ],
  "createdAt": "2026-09-25T09:12:44.512Z"
}

Get DeploymentRevision by Deployment Key

GET
https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}/revisions/{revision}
OAuth 2.0 Scopes:
manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}
Path parameters:
projectKey
​
String
​

The commercetools Project key.

key
​
String
​
key of the Deployment
revision
​
Int64
​
revisionNumber of the DeploymentRevision.
Minimum: 1​
region
​
String
​
Region in which the Project is hosted.
Response:
200

DeploymentRevision

as
application/json
Request Example:cURL
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}/revisions/{revision} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
200 Response Example: DeploymentRevisionjson
{
  "revisionNumber": 7,
  "currentRevision": false,
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "version": 1,
    "repository": {
      "url": "git@github.com:commercetools/connect-application-kit.git",
      "tag": "0.0.0"
    }
  },
  "globalConfiguration": {
    "standardConfiguration": [
      {
        "key": "GLOBAL_CONFIG_KEY",
        "value": "global config key value"
      }
    ],
    "securedConfiguration": []
  },
  "applications": [
    {
      "applicationName": "event-application",
      "standardConfiguration": [
        {
          "key": "CONFIG_KEY",
          "value": "config key value"
        }
      ],
      "securedConfiguration": [
        {
          "key": "CONFIG_SECRET",
          "value": "********"
        }
      ]
    }
  ],
  "createdAt": "2026-09-25T09:12:44.512Z"
}

Query DeploymentRevisions

Returns the revisions of a Deployment, most recent first. Only versions that were deployed successfully are returned, so every result is a valid rollback target.

Query DeploymentRevisions by Deployment ID

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

Retrieves the revisions of a Deployment, most recent first.

Only versions that were deployed successfully are returned, so every result is a valid rollback target. At most 20 revisions are returned.

OAuth 2.0 Scopes:
manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}
Path parameters:
projectKey
​
String
​

The commercetools Project key.

id
​
String
​
id of the Deployment
region
​
String
​
Region in which the Project is hosted.
Response:
200

as
application/json
Request Example:cURL
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}/revisions -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
200 Response Example: arrayjson
[
  {
    "revisionNumber": 8,
    "currentRevision": true,
    "connector": {
      "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
      "version": 1,
      "repository": {
        "url": "git@github.com:commercetools/connect-application-kit.git",
        "tag": "0.0.0"
      }
    },
    "globalConfiguration": {
      "standardConfiguration": [
        {
          "key": "GLOBAL_CONFIG_KEY",
          "value": "global config key value"
        }
      ],
      "securedConfiguration": []
    },
    "applications": [
      {
        "applicationName": "event-application",
        "standardConfiguration": [
          {
            "key": "CONFIG_KEY",
            "value": "config key value"
          }
        ],
        "securedConfiguration": [
          {
            "key": "CONFIG_SECRET",
            "value": "********"
          }
        ]
      }
    ],
    "rollbackRevision": 7,
    "createdAt": "2026-09-25T09:12:44.512Z"
  },
  {
    "revisionNumber": 7,
    "currentRevision": false,
    "connector": {
      "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
      "version": 1,
      "repository": {
        "url": "git@github.com:commercetools/connect-application-kit.git",
        "tag": "0.0.0"
      }
    },
    "globalConfiguration": {
      "standardConfiguration": [
        {
          "key": "GLOBAL_CONFIG_KEY",
          "value": "global config key value"
        }
      ],
      "securedConfiguration": []
    },
    "applications": [
      {
        "applicationName": "event-application",
        "standardConfiguration": [
          {
            "key": "CONFIG_KEY",
            "value": "config key value"
          }
        ],
        "securedConfiguration": [
          {
            "key": "CONFIG_SECRET",
            "value": "********"
          }
        ]
      }
    ],
    "createdAt": "2026-09-25T09:12:44.512Z"
  }
]

Query DeploymentRevisions by Deployment Key

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

Retrieves the revisions of a Deployment, most recent first.

Only versions that were deployed successfully are returned, so every result is a valid rollback target. At most 20 revisions are returned.

OAuth 2.0 Scopes:
manage_project:{projectKey}manage_connectors_deployments:{projectKey}view_connectors_deployments:{projectKey}
Path parameters:
projectKey
​
String
​

The commercetools Project key.

key
​
String
​
key of the Deployment
region
​
String
​
Region in which the Project is hosted.
Response:
200

as
application/json
Request Example:cURL
curl --get https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}/revisions -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
200 Response Example: arrayjson
[
  {
    "revisionNumber": 8,
    "currentRevision": true,
    "connector": {
      "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
      "version": 1,
      "repository": {
        "url": "git@github.com:commercetools/connect-application-kit.git",
        "tag": "0.0.0"
      }
    },
    "globalConfiguration": {
      "standardConfiguration": [
        {
          "key": "GLOBAL_CONFIG_KEY",
          "value": "global config key value"
        }
      ],
      "securedConfiguration": []
    },
    "applications": [
      {
        "applicationName": "event-application",
        "standardConfiguration": [
          {
            "key": "CONFIG_KEY",
            "value": "config key value"
          }
        ],
        "securedConfiguration": [
          {
            "key": "CONFIG_SECRET",
            "value": "********"
          }
        ]
      }
    ],
    "rollbackRevision": 7,
    "createdAt": "2026-09-25T09:12:44.512Z"
  },
  {
    "revisionNumber": 7,
    "currentRevision": false,
    "connector": {
      "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
      "version": 1,
      "repository": {
        "url": "git@github.com:commercetools/connect-application-kit.git",
        "tag": "0.0.0"
      }
    },
    "globalConfiguration": {
      "standardConfiguration": [
        {
          "key": "GLOBAL_CONFIG_KEY",
          "value": "global config key value"
        }
      ],
      "securedConfiguration": []
    },
    "applications": [
      {
        "applicationName": "event-application",
        "standardConfiguration": [
          {
            "key": "CONFIG_KEY",
            "value": "config key value"
          }
        ],
        "securedConfiguration": [
          {
            "key": "CONFIG_SECRET",
            "value": "********"
          }
        ]
      }
    ],
    "createdAt": "2026-09-25T09:12:44.512Z"
  }
]

Rollback DeploymentRevision

Restores a DeploymentRevision as a new Deployment version. The Connector version and all application configurations from the revision are applied to the new Deployment.

The rollback creates a new Deployment version rather than removing the current one, so the current Deployment remains available as a revision.

Rollback DeploymentRevision by Deployment ID

POST
https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}/revisions/{revision}/rollback

Restores the configuration of the revision onto the Deployment. A new Deployment version is created from the revision and deployed.

The manage_api_clients:{projectKey} scope is required if the connector version uses commercetools managed API Client credentials.

Specific Error Codes:

OAuth 2.0 Scopes:
manage_project:{projectKey}manage_connectors_deployments:{projectKey}
Path parameters:
projectKey
​
String
​

The commercetools Project key.

id
​
String
​
id of the Deployment
revision
​
Int64
​
revisionNumber of the DeploymentRevision.
Minimum: 1​
region
​
String
​
Region in which the Project is hosted.
Request Body:DeploymentRollbackasapplication/json
Response:
202

Deployment

as
application/json
Request Example:cURL
curl https://connect.{region}.commercetools.com/{projectKey}/deployments/{id}/revisions/{revision}/rollback -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 8
}
DATA
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"
}

Rollback DeploymentRevision by Deployment Key

POST
https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}/revisions/{revision}/rollback

Restores the configuration of the revision onto the Deployment. A new Deployment version is created from the revision and deployed.

The manage_api_clients:{projectKey} scope is required if the connector version uses commercetools managed API Client credentials.

Specific Error Codes:

OAuth 2.0 Scopes:
manage_project:{projectKey}manage_connectors_deployments:{projectKey}
Path parameters:
projectKey
​
String
​

The commercetools Project key.

key
​
String
​
key of the Deployment
revision
​
Int64
​
revisionNumber of the DeploymentRevision.
Minimum: 1​
region
​
String
​
Region in which the Project is hosted.
Request Body:DeploymentRollbackasapplication/json
Response:
202

Deployment

as
application/json
Request Example:cURL
curl https://connect.{region}.commercetools.com/{projectKey}/deployments/key={key}/revisions/{revision}/rollback -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 8
}
DATA
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"
}

Representations

DeploymentRevision

A previously deployed configuration of a Deployment.
revisionNumber​
Int64​

Version of the Deployment this revision was taken from.

currentRevision​
Boolean​

Whether this revision is the current version of the Deployment.

connector​
DeploymentRevisionConnector​

Identity, version, and source repository of the Connector that was deployed.

globalConfiguration​
DeploymentGlobalConfiguration​

Global configuration applied to all applications at this revision.

applications​
Array of DeploymentRevisionApplication​

Configuration of each application at this revision.

rollbackRevision​
Int64​

The revision this one restored. Only present when the revision was itself produced by a rollback.

createdAt​
DateTime​

Date and time (UTC) the revision was created.

Example: json
{
  "revisionNumber": 7,
  "currentRevision": false,
  "connector": {
    "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
    "version": 1,
    "repository": {
      "url": "git@github.com:commercetools/connect-application-kit.git",
      "tag": "0.0.0"
    }
  },
  "globalConfiguration": {
    "standardConfiguration": [
      {
        "key": "GLOBAL_CONFIG_KEY",
        "value": "global config key value"
      }
    ],
    "securedConfiguration": []
  },
  "applications": [
    {
      "applicationName": "event-application",
      "standardConfiguration": [
        {
          "key": "CONFIG_KEY",
          "value": "config key value"
        }
      ],
      "securedConfiguration": [
        {
          "key": "CONFIG_SECRET",
          "value": "********"
        }
      ]
    }
  ],
  "createdAt": "2026-09-25T09:12:44.512Z"
}

DeploymentRevisionConnector

Identity and source of the Connector that was deployed at a DeploymentRevision. Rolling back restores this Connector version.
id​
String​
id of the Connector.
version​
Int​

Version of the Connector.

repository​
Repository​

Details of the GitHub repository that contains the Connect applications.

Example: json
{
  "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
  "version": 1,
  "repository": {
    "url": "git@github.com:commercetools/connect-application-kit.git",
    "tag": "0.0.0"
  }
}

DeploymentRevisionApplication

Configuration of an application as it was at a DeploymentRevision.
applicationName​
String​

Name of the application.

MinLength: 2​MaxLength: 256​Pattern: ^[A-Za-z0-9_-]+$​
standardConfiguration​
Array of ConfigurationValue​

Contains values of keys that are saved in plain text.

securedConfiguration​
Array of ConfigurationValue​

Contains keys of secret values. The values themselves are masked.

topic​
String​

Google Cloud Pub/Sub Topic when application type is event.

schedule​
String​

Cron schedule for when application type is job.

retryPolicy​
RetryPolicy​

Retry policy applied when application type is event.

Example: json
{
  "applicationName": "event-application",
  "standardConfiguration": [
    {
      "key": "CONFIG_KEY",
      "value": "config key value"
    }
  ],
  "securedConfiguration": [
    {
      "key": "CONFIG_SECRET",
      "value": "********"
    }
  ],
  "retryPolicy": {
    "strategy": "exponential-backoff",
    "minBackoffSeconds": 10,
    "maxBackoffSeconds": 120,
    "maxAttempts": 10
  }
}

DeploymentRollback

Body of a rollback request. The revision to restore is given in the request path, so the body only carries the concurrency check.

version​
Int64​

Expected version of the Deployment on which the changes apply.

Example: json
{
  "version": 8
}