Configs

List config versions

GET

Path parameters

idstringRequired
Identifier for a Config. Formatted as a UUID.

Query parameters

page_numberintegerOptional

Specifies the page number to retrieve, enabling pagination.

This parameter uses zero-based indexing. For example, setting page_number to 0 retrieves the first page of results (items 0-9 if page_size is 10), setting page_number to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

page_sizeintegerOptional

Specifies the maximum number of results to include per page, enabling pagination.

The value must be greater than or equal to 1. For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

restrict_to_most_recentbooleanOptional

By default, restrict_to_most_recent is set to true, returning only the latest version of each config. To include all versions of each config in the list, set restrict_to_most_recent to false.

Response

This endpoint returns an object
total_pages
integer
The total number of pages in the collection.
page_number
integerOptional

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_size
integerOptional

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.

configs_page
list of objectsOptional

List of configs returned for the specified page_number and page_size.

Built with