Get Index

GET /indexes/{indexUid}

Api key

Get information about an index.

Path parameters

indexUid string Required

Index Unique Identifier

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- uid string Required
  
  Unique identifier for the index
- primaryKey string | null
  
  Custom primaryKey for documents
- createdAt string Required
  
  An RFC 3339 format for date/time/duration.
- updatedAt string Required
  
  An RFC 3339 format for date/time/duration.
- Additional properties are NOT allowed
• 401 application/json

Unauthorized
Hide response attributes Show response attributes object
- message string Required
- code string Required
- type string Required
- link string Required
• 404

Not Found

GET /indexes/{indexUid}

curl \
 -X GET https://example.meilisearch.com:7700/indexes/movies \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "uid": "movies",
  "primaryKey": "movie_id",
  "createdAt": "2019-11-20T09:40:33.711324Z",
  "updatedAt": "2019-11-20T09:40:33.711324Z"
}

Response examples (401)

{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}