deployments

Cancel a queued or building deployment

Cancel a deployment that has not been handed over to the controller yet (QUEUED or BUILDING)

post/deployment/{deployment_id}/cancel

Request

  • Base URL: https://api.faable.com
  • URL: https://api.faable.com/deployment/{deployment_id}/cancel
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://faable.auth.faable.link/authorize, token URL https://faable.auth.faable.link/oauth/token)
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://faable.auth.faable.link/oauth/token)
    • HTTP bearer
    • HTTP basic
    • API key in query parameter apikey

Path parameters

deployment_idstring required

Response

Deployment

idstring required

Deployment ID

teamstring required
app_idstring required
imagestring
releasestring
github_commitstring
github_refstring
github_actorstring
github_commit_messagestring
artifact_idstring
artifact_ready_atstring date-time
build_started_atstring date-time
build_msinteger
redeploy_ofstring
rebuild_ofstring
quota_released_atstring date-time
triggerstring
metadataobject required
createdAtstring required

Deployment creation date

updatedAtstring

Deployment updated date

Changes

No recorded changes to this operation across all 1 revision of this API.