Get index - Meilisearch Documentation

Authorization

string

header

required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new Meilisearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

index_uid

string

required

Unique identifier of the index.

The index is returned.

An index containing searchable documents

uid

string

required

Unique identifier for the index. Once created, it cannot be changed

createdAt

string<date-time>

required

Creation date of the index, represented in RFC 3339 format

updatedAt

string<date-time>

required

Latest date of index update, represented in RFC 3339 format

primaryKey

string | null

Primary key of the index