List configs | Hume API

Fetches a paginated list of Configs.

For more details on configuration options and how to configure EVI, see our configuration guide.

Authentication

X-Hume-Api-Keystring

API Key authentication via header

Query parameters

• page_number (integer, Optional): Defaults to 0
  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_size (integer, Optional):
  Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive. For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

• restrict_to_most_recent (boolean, Optional):
  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.

• name (string, Optional):
  Filter to only include configs with this name.

Response

• Success
  • total_pages (integer): The total number of pages in the collection.
  • configs_page (list of objects): List of configs returned for the specified page_number and page_size.
    • Show 19 properties
    • page_number (integer): 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 (integer): The maximum number of items returned per page. This value corresponds to the page_size parameter specified in the request.