v2

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-26192307950.1 KB

workspaces

List Workspace Stack Components

List stack components that are part of a specific workspace.

noqa: DAR401

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

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

Path parameters

string required

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

string

string date-time

string

string date-time

string

scope_workspacestring uuid nullable

scope_typestring nullable

namestring nullable

flavorstring nullable

typestring nullable

string uuid

string

string uuid

string

string uuid

string

string uuid

string

Response

Successful Response

indexinteger required

max_sizeinteger required

total_pagesinteger required

totalinteger required