Get stacks of an organization
All stacks matching a given status are returned.
For the time being, if no page query parameter
is provided, all stacks will be returned.
Stacks that are soft-deleted are not returned.
Access
- Only members of the organization with any role are allowed to query.
Authorizations
API key as username in Basic Authorization with
empty password.
Parameters
Path Parameters
UUID of the organization
"uuid"Query Parameters
Page number to return
1"int64"1Number of elements per page
"int64"110Only select entities whose repository matches any
of the strings in the provided array. Only full strings will
be matched.
Only select entities whose deployment target matches any
of the strings in the provided array. Only full strings will
be matched.
only select stacks with specific status e.g. for dashboard view.
{
"AllPossibleValues": {
"value": [
"all",
"unhealthy",
"healthy",
"drifted",
"failed",
"ok"
]
}
}Only select stacks with these last known
deployment status.
{
"AllPossibleValues": {
"value": [
"canceled",
"failed",
"ok",
"pending",
"running"
]
}
}Only select entities with these last known drift status.
{
"AllPossibleValues": {
"value": [
"ok",
"drifted",
"failed"
]
}
}Only select stacks with the provided draft value.
falsetrue - Only select entities that are archived.
false - Only select entities that are not archived (default).
true,false - Select all entities.
{
"AllPossibleValues": {
"value": [
true,
false
]
}
}This performs a substring search on the following stack
attributes:
- meta_id
- meta_name
- meta_description
- path
"stackTitle"Only select stacks where meta_id matches this value.
"4106cc6-ec4b-4ef7-a0eb-d927f860e176"Deployment UUID
"096c55b6-1599-4a17-a48f-fa846a84aa8a""uuid"Only select stacks where the meta_tags includes the given tag.
If they are provided multiple times ALL values should be
contained in the meta_tags. If the string contains ',' then
ANY value should be in the meta_tags.
{
"TwoTagsExample": {
"Value": [
"tag_a",
"tag_b"
]
}
}Only select entities that have specific policy check results.
Available options:
- missing: No analysis data available.
- none: No checks defined for the entity.
- passed: Entity has no violations.
- low: Entity has violations with low severity.
- medium: Entity has violations with medium severity.
- high: Entity has violations with high severity.
Stacks are sorted with updated_at by default.
Available sorts are:
- meta_name[,(asc|desc)]
- path[,(asc|desc)]
- policy_severity[,(desc|asc)]
- repository[,(asc|desc)]
- resource_count[,(desc|asc)]
- status[,(asc|desc)]
- target[,(asc|desc)]
- updated_at[,(desc|asc)]
{
"UpdatedAtDescPathDescExample": {
"Value": [
"updated_at,asc",
"path,desc"
]
}
}Responses
OK