List indexes

GET

This method returns a list of the indexes in your account. The API returns indexes sorted by creation date, with the oldest indexes at the top of the list.

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

sort_bystringOptionalDefaults to created_at

The field to sort on. The following options are available:

  • updated_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the item was updated.
  • created_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the item was created.

Default: created_at.

sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

_idstringOptional

Filter by the unique identifier of an index.

index_namestringOptional

Filter by the name of an index.

engine_optionsstringOptional

Filter by the engine options. When filtering by multiple engine options, the values must be comma-separated.

engine_familystringOptional

Filter by the engine family. This parameter can take one of the following values: marengo or pegasus. You can specify a single value.

index_optionsstringOptional

Filter by the indexing options. When filtering by multiple indexing options, the values must be comma-separated.

Note

This parameter is supported for backward compatibility and will be deprecated in a future release. Instead, use engine_options or engine_family.

created_atstringOptional

Filter indexes by the creation date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”). The platform returns the indexes that were created on the specified date at or after the given time.

updated_atstringOptional

Filter indexes by the last update date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”). The platform returns the indexes that were last updated on the specified date at or after the given time.

Response

The indexes have successfully been retrieved.

datalist of objectsOptional

An array that contains up to page_limit indexes.

page_infoobjectOptional

An object that provides information about pagination.

Errors

Built with