Sign in
Workloads

List Workloads

List all Workloads owned by your account.

get/workspace/workloads

Query parameters

activeboolean

Filter by active status.

digital_certificate_idinteger

Filter by digital certificate id (accepts comma-separated values).

fieldsstring

Comma-separated list of field names to include in the response. Nested fields can be accessed using dot notation.

idinteger

Filter by id (accepts comma-separated values).

infrastructurestring

Filter by infrastructure (accepts comma-separated values).

last_editorstring

Filter by last editor (case-insensitive, partial match).

last_modified__gtestring date-time

Filter by last modified date (greater than or equal).

last_modified__ltestring date-time

Filter by last modified date (less than or equal).

map_namestring

Filter by map name (case-insensitive, partial match).

mtls_trusted_ca_certificate_idinteger

Filter by mTLS trusted CA certificate id (accepts comma-separated values).

namestring

Filter by name (case-insensitive, partial match).

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

A numeric value that indicates the number of items per page.

searchstring

A search term.

Response

List of workloads retrieved successfully.

countinteger

Total number of items

total_pagesinteger

Total number of pages

pageinteger

Current page number

page_sizeinteger

Number of items per page

nextstring uri nullable

URL to the next page of results

previousstring uri nullable

URL to the previous page of results

Example response

{
  "count": 123,
  "total_pages": 10,
  "page": 1,
  "page_size": 10,
  "next": "https://api.example.com/items?page=3",
  "previous": "https://api.example.com/items?page=1"
}

Changes