Indexes
This section describes the API calls used to create, read, update and delete database indexes. The page builds upon (and assumes you've read) the API Usage Guide. Please ensure you're familiar with the API calling conventions before reading on.
List all indexes for a database
The database to search for indexes.
The globally unique identifier of the database.
The maximum number of results to return in this page.
A token used to paginate the search results. Cursors returned in previous responses can be used in subsequent requests.
The number of results returned.
Whether there are more results on the next page
A token that can be used to request the next page of results. It's only useful if has_more is true.
A list of results.
The globally unique identifier of the index.
The database associated with this index.
The globally unique identifier of the database.
The type of this index. Can be text, datetime, keyword, integer, float or boolean.
The display name of the index.
A path to searchable text within record contents, using dot notation.
Fetch an index
The globally unique identifier of the index to fetch.
The globally unique identifier of the index.
The database associated with this index.
The globally unique identifier of the database.
The type of this index. Can be text, datetime, keyword, integer, float or boolean.
The display name of the index.
A path to searchable text within record contents, using dot notation.
Create an index
The database to hold this index.
The globally unique identifier of the database.
The type of this index. Can be text, datetime, keyword, integer, float or boolean.
The display name of the index.
A path to searchable text within record contents, using dot notation.
A globally unique identifier of the newly created index.
Delete an index
The globally unique identifier of the index.
Always null if successful.