Sign in
Deployments

Promote a deployment to another environment

Changed on

Creates a new deployment in the target environment using the source deployment's Docker image. Useful for promoting a validated preview/staging deployment to production.

post/projects/{project_id}/deployments/{deployment_id}/promote

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/deployments/{deployment_id}/promote
  • Auth: none declared

Path parameters

project_idinteger required

Project ID

deployment_idinteger required

Source deployment ID to promote

Request body

target_environment_idinteger required

Target environment ID to promote the deployment to

Response

Promotion initiated successfully

branchstring nullable
cancelled_reasonstring nullable
commit_authorstring nullable
commit_dateinteger nullable
commit_hashstring nullable
commit_messagestring nullable
created_atinteger required
environment_idinteger required
finished_atinteger nullable
idinteger required
is_currentboolean required
project_idinteger required
screenshot_locationstring nullable
started_atinteger nullable
statusstring required
tagstring nullable
urlstring required

Example response

{
  "environment": {
    "service_urls": [
      {
        "port": 3000,
        "service": "web",
        "url": "https://web--production.localho.st"
      }
    ]
  }
}

Changes

  • c026cead1518Revision changes
    • warning

      added the new image_pull_failed enum value to the ///// response property for the response status

    • warning

      added the new registry_unavailable enum value to the ///// response property for the response status

  • 3c75d3f3795cRevision changes
    • info

      added the optional property to the response with the status