v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-27192307552.2 KB
workspaces

List Workspace Stacks

Get stacks that are part of a specific workspace for the user.

noqa: DAR401

Args: workspace_name_or_id: Name or ID of the workspace. 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 part of the specified workspace.

get/api/v1/workspaces/{workspace_name_or_id}/stacks

Path parameters

string required
OR
string uuid required

Query parameters

hydrateboolean
sort_bystring
logical_operator'or' | 'and'

Logical Ops to use to combine filters on list methods.

pageinteger
sizeinteger
string uuid
OR
string
string date-time
OR
string
string date-time
OR
string
scope_workspacestring uuid nullable
namestring nullable
descriptionstring nullable
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string

Response

Successful Response

indexinteger required
max_sizeinteger required
total_pagesinteger required
totalinteger required