Sign in
Deployments

Create a deployment

Triggers a deployment for a project environment. The environment defaults to production.

post/deployments

Request

  • Base URL: /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/deployments
  • Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

environment_slugstring

The environment slug to deploy. Defaults to production.

project_slugstring required

The project slug to deploy.

Example request

{
  "$schema": "/v1/schemas/CreateDeploymentInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

When the deployment was created.

desired_statestring required

The desired state (run or stop).

github_branchstring required

The branch the deployment builds from.

github_commitstring required

The commit SHA the deployment builds from.

github_commit_authorstring required

The commit author's GitHub login.

github_commit_messagestring required

The first line of the commit message.

idstring required

The deployment ID.

statusstring required

Derived deployment status (INITIALIZING, BUILDING, DEPLOYING, HEALTHCHECK, RUNNING, STOPPED, FAILED, PENDING).

status_changed_atstring date-time required

When the deployment status last changed.

Example response

{
  "$schema": "/v1/schemas/DeploymentResponse.json"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.