Get stack deployments.
GET
/v1/stack_deployments/{org_uuid}
Get stack deployments for an organization.
Authorizations
jwtToken
TypeHTTP (bearer)
or
apiKey
API key as username in Basic Authorization with
empty password.
TypeAPI Key (header: Authorization)
Parameters
Path Parameters
org_uuid*
UUID of the organization
Typestring
Requiredformat
"uuid"Query Parameters
page
Page number to return
Typeinteger
Example
1format
"int64"minimum
1per_page
Number of elements per page
Typeinteger
format
"int64"minimum
1default
10created_at_from
Only entities that has a created_at timestamp from this date including
the date.
Typestring
Example
"2024-04-11T20:31:00Z"format
"date-time"created_at_to
Only entities that has a created_at timestamp up to this date including
the date.
Typestring
Example
"2024-04-11T21:31:00Z"format
"date-time"deployment_status
Only select stacks with these last known
deployment status.
Typearray
Example
{
"AllPossibleValues": {
"value": [
"canceled",
"failed",
"ok",
"pending",
"running"
]
}
}Responses
OK
application/json
JSON
{
"stack_deployments": [
{
"id": 42,
"deployment_uuid": "096c55b6-1599-4a17-a48f-fa846a84aa8a",
"path": "/stacks/organizations/terramate.io/landing-zone/iam",
"cmd": [
[
"terraform",
"apply"
]
],
"status": "string",
"created_at": "string",
"started_at": "string",
"finished_at": "string",
"fixed_at": "string",
"stack": {
"stack_id": 1337,
"repository": "github.com/terramate-io/iac-gcloud",
"target": "staging",
"path": "/path/to/stack",
"default_branch": "main",
"meta_id": "a754255a-c92a-4aeb-9668-bd3ce21dc8a2",
"meta_name": "My Stack Name",
"meta_description": "My Stack Description",
"meta_tags": [
[
"tagA",
"tagB"
]
],
"status": "string",
"created_at": "string",
"updated_at": "string",
"seen_at": "string",
"is_archived": true,
"archived_at": "string",
"archived_by_user_uuid": "string",
"unarchived_at": "string",
"unarchived_by_user_uuid": "string",
"deployment_status": "string",
"drift_status": "string",
"draft": true,
"related_stacks": [
{
"stack_id": 0,
"target": "string"
}
],
"resources": {
"count": 42,
"policy_check": {
"created_at": "2024-09-12T07:06:00Z",
"passed": false,
"counters": {
"passed_count": 42,
"severity_low_count": 3,
"severity_medium_count": 2,
"severity_high_count": 1
}
}
}
},
"changeset_details": {
"provisioner": "string",
"serial": 0,
"changeset_ascii": "string",
"changeset_json": "string"
},
"metrics": {
"lead_time_for_change_seconds": 1,
"time_to_restore_seconds": 121
},
"review_request": {
"created_at": "string"
}
}
],
"paginated_result": {
"total": 0,
"page": 0,
"per_page": 0
}
}