Sign in
Storage - Buckets

List buckets

List all buckets.

get/workspace/storage/buckets

Query parameters

bucketstring

Filter by bucket (exact match).

createdstring date-time

Filter by creation date (exact match).

created__gtestring date-time

Filter by creation date (greater than or equal).

created__ltestring date-time

Filter by creation date (less than or equal).

descriptionstring

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

fieldsstring

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

last_editorstring

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

last_modifiedstring date-time

Filter by last modified date (exact 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).

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.

statusstring

Filter by status (accepts comma-separated values).

workloads_accessstring

Filter by workloads access (accepts comma-separated values).

Response

List of buckets 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

No recorded changes to this endpoint across all 1 revision of this API.