List workspaces

This operation lists all workspaces in your account, optionally filtered by query parameters.

Query Params
integer
Defaults to 100

Controls how many items are returned per page when paginating results.

integer
Defaults to 1

Controls which page to fetch from results when paginating responses.

string

A set of comma-delimited contracts to filter results by, linking to billing or licensing agreements.

string

A set of comma-delimited groups to filter results by. This corresponds to the defaultGroupId and additionalGroupIds data in requests.

string

Returns only those resources deployed under a set of comma-delimited products.

Returns only those resources that contain the specified string.

string

Returns only those resources that contain a set of tags. Use different delimiters to filter using logical operators: + for AND, , for OR, or | for exclusive XOR.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers
string
^(\\W)?"

This header prevents accidental overwrites and conflicts by making requests conditional. When you pass in a resource's ETag as an If-Match test, the update succeeds only if the resource hasn't changed. If the current ETag doesn't match and the data has changed, the server responds with a 412 error. See the Concurrency control section for more details.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json