Update index

Update the primary key or uid of an index.

Returns an error if the index does not exist or if it already contains documents (primary key cannot be changed in that case).

PATCH /indexes/{indexUid}

cURL

cURL

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/movies' \
  -H 'Content-Type: application/json' \
  --data-binary '{ "primaryKey": "id" }'

202

{
  "taskUid": 0,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "indexUpdate",
  "enqueuedAt": "2021-01-01T09:39:00.000000Z"
}

Authorizations

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'
});

Path Parameters

indexUid · string · required

Unique identifier of the index.

Body

application/json

Request body for updating an existing index

primaryKey · string | null

New primary key of the index

uid · string | null

New uid for the index (for renaming)

Response

202

application/json

Task successfully enqueued.

A summarized view of a task, returned when a task is enqueued

taskUid · integer<u-int32> · required

Unique sequential identifier of the task.

Required range: x >= 0

status · enum<string> · required

Status of the task. Possible values are enqueued, processing, succeeded, failed, and canceled.

Available options: enqueued, processing, succeeded, failed, canceled

Example:

"processing"

type · enum<string> · required

Type of operation performed by the task.

Available options: documentAdditionOrUpdate, documentEdition, documentDeletion, settingsUpdate, indexCreation, indexDeletion, indexUpdate, indexSwap, taskCancelation, taskDeletion, dumpCreation, snapshotCreation, export, upgradeDatabase, indexCompaction, networkTopologyChange

Example:

"documentAdditionOrUpdate"

enqueuedAt · string<date-time> · required

Date and time when the task was enqueued.

indexUid · string | null

Unique identifier of the targeted index. Null for global tasks.

customMetadata · string | null

Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information.