Appearance

Batch update stack status for a deployment.​

PATCH
/v1/deployments/{org_uuid}/{deployment_uuid}/stacks

Update the status of a specific deployment (identified by deployment_uuid).

Status Lifecycle of a Deployment and Stacks

The status of a stack, can be any of the following:

  • ok - when a stack is considered healthy and correctly configured (considered healthy)
  • drifted - when a stack definition is different from that of the current status (considered unhealthy)
  • failed - when the latest apply of the stack failed (considered unhealthy)
  • unknown - the initial status of a newly created stack or the status of a stale stack (considered unhealthy)
  • canceled - when a preceeding stack in a deployment failed, the subsequent stacks will be canceled (considered unhealthy)

The status of a deployment has in some cases a direct relationship with the status of a stack. The status of a deployment can be any of the following:

  • pending - temporary status as part of a deployment about to commence. Set by the POST endpoint when creating a deployment
  • running - temporary status as part of a running a deployment
  • ok - when a deployment is considered successfully deployed with no errors. Will also set the ok status of the stacks in the deployment
  • failed - when a deployment has failed to apply correctly. Will also set the failed status of the stacks in the deployment
  • canceled - after a specific stack has failed, and the execution of the succeeding stacks is canceled. Will also set the canceled status of the stacks in the deployment

Terramate Cli Deployment Status
Terramate CLI will use this endpoint to set the deployment status to one of the following:

  • running
  • ok
  • failed
  • canceled

Access

  • Members of the organization with a member role.
  • Trusted GitHub Owner.

Authorizations​

apiKey

API key as username in Basic Authorization with
empty password.

TypeAPI Key (header: Authorization)
or
jwtToken
TypeHTTP (bearer)

Parameters​

Path Parameters

org_uuid*

UUID of the organization

Typestring
Required
format"uuid"
deployment_uuid*

UUID of the deployment

Typestring
Required
format"uuid"

Request Body​

application/json
JSON
{
"stacks": [
{
"stack_id": 42,
"status": "string",
"changeset_details": {
"provisioner": "string",
"serial": 0,
"changeset_ascii": "string",
"changeset_json": "string"
}
}
]
}

Responses​

No Content

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI