deployments

Cancel deployment

Requests cancellation of a deployment that is currently building.

For a deployment that is not building, nothing changes and the response has ok: false.

Required permission: deployments.cancel.

post/v1/projects/{project_id}/deployments/{deployment_id}/cancel

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/deployments/{deployment_id}/cancel
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

deployment_idstring uuid required

Deployment ID from GET /deployments.

Response

Successful Response

okboolean required

Whether the operation succeeded.

message'Cancellation requested' | 'Deployment is not building' | 'Deployment is no longer building' required

Cancellation requested when the build is being stopped. Deployment is not building or Deployment is no longer building when there was no build to cancel; ok is false.

Changes

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