Stacks

List Stacks

get

Returns all stacks.

Args: project_name_or_id: Optional name or ID of the project to filter by. stack_filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: All stacks matching the filter criteria.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofOptional
stringOptional
or
string · uuidOptional
or
nullOptional
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
component_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
componentany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/v1/stacks

Get Stack

get

Returns the requested stack.

Args: stack_id: ID of the stack. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The requested stack.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
stack_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
200

Successful Response

application/json
get
/api/v1/stacks/{stack_id}

Update Stack

put

Updates a stack.

Args: stack_id: Name of the stack. stack_update: Stack to use for the update.

Returns: The updated stack.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
stack_idstring · uuidRequired
Body

Update model for stacks.

nameany ofOptional
string · max: 255Optional
or
nullOptional
descriptionany ofOptional
string · max: 255Optional
or
nullOptional
stack_spec_pathany ofOptional
stringOptional
or
nullOptional
componentsany ofOptional
or
nullOptional
environmentany ofOptional
or
nullOptional
labelsany ofOptional
or
nullOptional
add_secretsany ofOptional
or
nullOptional
remove_secretsany ofOptional
or
nullOptional
Responses
200

Successful Response

application/json
put
/api/v1/stacks/{stack_id}

Delete Stack

delete

Deletes a stack.

Args: stack_id: Name of the stack.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
stack_idstring · uuidRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/v1/stacks/{stack_id}

No content

Last updated

Was this helpful?