Skip to content

Get affected stacks for an alert.

GET
/v1/alerts/{org_uuid}/{alert_uuid}/stacks

Get affected stacks for an alert.

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"
alert_uuid*

The ID of the alert

Typestring
Required
Example"01c9fb02-7648-45f5-9bdd-f2c27e59c448"
format"uuid"

Query Parameters

page

Page number to return

Typeinteger
Example1
format"int64"
minimum1
per_page

Number of elements per page

Typeinteger
format"int64"
minimum1
default10
sort

Sorting

Allows for sorting of the returned entities based on specified fields and order.
Multiple fields can be provided with their sorting direction, separated by commas.
For example, to sort by 'updated_at' in ascending order and then by 'path' in descending order,
the parameter can be specified as follows: sort=updated_at,asc&sort=path,desc.
By default, entities are sorted by 'updated_at' in descending order.

Typearray
Example{ "UpdatedAtDescPathDescExample": { "Value": [ "updated_at,asc", "path,desc" ] } }

Responses

OK

application/json
JSON
{
"affected_stacks": [
{
"stack_status_in_alert": "ok",
"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
}
}
}
}
}
],
"paginated_result": {
"total": 0,
"page": 0,
"per_page": 0
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI