Indexes

The /indexes route allows you to create, manage, and delete your indexes. Learn more about indexes.

Index object

{
  "uid": "movies",
  "createdAt": "2022-02-10T07:45:15.628261Z",
  "updatedAt": "2022-02-21T15:28:43.496574Z",
  "primaryKey": "id"
}

Name	Type	Default value	Description
`uid`	String	N/A	Unique identifier of the index. Once created, it cannot be changed
`createdAt`	String	N/A	Creation date of the index, represented in RFC 3339 format. Auto-generated on index creation
`updatedAt`	String	N/A	Latest date of index update, represented in RFC 3339 format. Auto-generated on index creation or update
`primaryKey`	String / `null`	`null`	Primary key of the index. If not specified, Meilisearch guesses your primary key from the first document you add to the index

List all indexes

GET

/indexes

List all indexes. Results can be paginated by using the offset and limit query parameters.

Query parameters

Query parameter	Description	Default value
`offset`	Number of indexes to skip	`0`
`limit`	Number of indexes to return	`20`

Response

Name	Type	Description
`results`	Array	An array of indexes
`offset`	Integer	Number of indexes skipped
`limit`	Integer	Number of indexes returned
`total`	Integer	Total number of indexes

Example

curl \
  -X GET 'MEILISEARCH_URL/indexes?limit=3'

client.getIndexes({ limit: 3 })

client.get_indexes({'limit': 3})

$client->getIndexes((new IndexesQuery())->setLimit(3));

IndexesQuery query = new IndexesQuery().setLimit(3);
client.getIndexes(query);

client.indexes(limit: 3)

client.GetIndexes(&meilisearch.IndexesQuery{
  Limit: 3,
})

await client.GetAllIndexesAsync(new IndexesQuery { Limit = 3 });

let mut indexes = IndexesQuery::new(&client)
  .with_limit(3)
  .execute()
  .await
  .unwrap();

client.getIndexes { (result) in
    switch result {
    case .success(let indexes):
        print(indexes)
    case .failure(let error):
        print(error)
    }
}

await client.getIndexes(params: IndexesQuery(limit: 3));

Response: `200 Ok`

{
  "results": [
    {
      "uid": "books",
      "createdAt": "2022-03-08T10:00:27.377346Z",
      "updatedAt": "2022-03-08T10:00:27.391209Z",
      "primaryKey": "id"
    },
    {
      "uid": "meteorites",
      "createdAt": "2022-03-08T10:00:44.518768Z",
      "updatedAt": "2022-03-08T10:00:44.582083Z",
      "primaryKey": "id"
    },
    {
      "uid": "movies",
      "createdAt": "2022-02-10T07:45:15.628261Z",
      "updatedAt": "2022-02-21T15:28:43.496574Z",
      "primaryKey": "id"
    }
  ],
  "offset": 0,
  "limit": 3,
  "total": 5
}  

Get one index

GET

/indexes/{index_uid}

Get information about an index.

Path parameters

Name	Type	Description
`index_uid` *	String	`uid` of the requested index

Example

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies'

client.index('movies').getRawInfo()

client.get_index('movies')

$client->index('movies')->fetchRawInfo();

client.getIndex("movies");

client.fetch_index('movies')

client.GetIndex("movies")

await client.GetIndexAsync("movies");

let movies: Index = client
  .get_index("movies")
  .await
  .unwrap();

client.getIndex("movies") { (result) in
    switch result {
    case .success(let index):
        print(index)
    case .failure(let error):
        print(error)
    }
}

await client.getIndex('movies');

Response: `200 Ok`

{
  "uid": "movies",
  "createdAt": "2022-02-10T07:45:15.628261Z",
  "updatedAt": "2022-02-21T15:28:43.496574Z",
  "primaryKey": "id"
}

Create an index

POST

/indexes

Create an index.

Body

Name	Type	Default value	Description
`uid` *	String	N/A	`uid` of the requested index
`primaryKey`	String / `null`	`null`	`Primary key` of the requested index

{
  "uid": "movies",
  "primaryKey": "id"
}

Example

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

client.createIndex('movies', { primaryKey: 'id' })

client.create_index('movies', {'primaryKey': 'id'})

$client->createIndex('movies', ['primaryKey' => 'id']);

client.createIndex("movies", "id");

client.create_index('movies', primary_key: 'id')

client.CreateIndex(&meilisearch.IndexConfig{
  Uid: "movies",
  PrimaryKey: "id",
})

TaskInfo task = await client.CreateIndexAsync("movies", "id");

client.create_index("movies", Some("id"))
  .await
  .unwrap();

client.createIndex(uid: "movies", primaryKey: "id") { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.createIndex('movies', primaryKey: 'id');

Response: `202 Accepted`

{
  "taskUid": 0,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "indexCreation",
  "enqueuedAt": "2021-08-12T10:00:00.000000Z"
}

You can use the response’s taskUid to track the status of your request.

Update an index

PATCH

/indexes/{index_uid}

Update an index’s primary key. You can freely update the primary key of an index as long as it contains no documents. To change the primary key of an index that already contains documents, you must first delete all documents in that index. You may then change the primary key and index your dataset again.

Path parameters

Name	Type	Description
`index_uid` *	String	`uid` of the requested index

Body

Name	Type	Default value	Description
`primaryKey` *	String / `null`	N/A	`Primary key` of the requested index
`uid` *	String / `null`	N/A	New `uid` of the requested index

Example

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

client.updateIndex('movies', { primaryKey: 'id' })

client.index('movies').update(primary_key='id')

$client->updateIndex('movies', ['primaryKey' => 'id']);

client.updateIndex("movies", "id");

client.index('movies').update(primary_key: 'movie_id')

client.Index("movies").UpdateIndex(&meilisearch.UpdateIndexRequestParams{
  PrimaryKey: "id",
})

TaskInfo task = await client.UpdateIndexAsync("movies", "id");

let task = IndexUpdater::new("movies", &client)
  .with_primary_key("movie_review_id")
  .execute()
  .await
  .unwrap();

client.index("movies").update(primaryKey: "id") { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').update(primaryKey: 'id');

Response: `202 Accepted`

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "indexUpdate",
  "enqueuedAt": "2021-08-12T10:00:00.000000Z"
}

You can use the response’s taskUid to track the status of your request.

Delete an index

DELETE

/indexes/{index_uid}

Delete an index.

Path parameters

Name	Type	Description
`index_uid` *	String	`uid` of the requested index

Example

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies'

client.deleteIndex('movies')

client.delete_index('movies')
// OR
client.index('movies').delete()

$client->deleteIndex('movies');

client.deleteIndex("movies");

client.delete_index('movies')

client.DeleteIndex("movies")
// OR
client.Index("movies").Delete()

await client.DeleteIndexAsync("movies");

client.index("movies")
  .delete()
  .await
  .unwrap();

client.index("movies").delete { (result) in
    switch result {
    case .success:
        print("Index deleted")
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').delete();

Response: `202 Accepted`

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "indexDeletion",
  "enqueuedAt": "2021-08-12T10:00:00.000000Z"
}

You can use the response’s taskUid to track the status of your request.

Swap indexes

POST

/swap-indexes

Swap the documents, settings, and task history of two or more indexes. You can only swap indexes in pairs. A single request can swap as many index pairs as you wish. Swapping indexes is an atomic transaction: either all indexes in a request are successfully swapped, or none are. You can swap multiple pairs of indexes with a single request. To do so, there must be one object for each pair of indexes to be swapped. Swapping indexA and indexB will also replace every mention of indexA by indexB and vice-versa in the task history. enqueued tasks are left unmodified. To learn more about index swapping, refer to this short guide.

Body

An array of objects with the following fields:

Name	Type	Default value	Description
`indexes`	Array of strings	N/A	Array of the two `indexUid`s to be swapped
`rename`	Boolean	`false`	If `true`, renames an index instead of swapping it

Each indexes array must contain only two elements: the indexUids of the two indexes to be swapped. Sending an empty array ([]) is valid, but no swap operation will be performed. Use rename: false if you are swapping two existing indexes. Use rename: true if the second index in your array does not exist.

Example

curl \
  -X POST 'MEILISEARCH_URL/swap-indexes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    {
      "indexes": [
        "indexA",
        "indexB"
      ]
    },
    {
      "indexes": [
        "indexX",
        "indexY"
      ]
    }
  ]'

client.swapIndexes([
  { 'indexes': ['indexA', 'indexB'] },
  { 'indexes': ['indexX', 'indexY'] }
])

client.swap_indexes([{'indexes': ['indexA', 'indexB']}, {'indexes': ['indexX', 'indexY']}])

$client->swapIndexes([['indexA', 'indexB'], ['indexX', 'indexY']]);

SwapIndexesParams[] params =
        new SwapIndexesParams[] {
            new SwapIndexesParams().setIndexes(new String[] {"indexA", "indexB"}),
            new SwapIndexesParams().setIndexes(new String[] {"indexX", "indexY"})
        };
TaskInfo task = client.swapIndexes(params);

client.swap_indexes(['indexA', 'indexB'], ['indexX', 'indexY'])

client.SwapIndexes([]SwapIndexesParams{
  {Indexes: []string{"indexA", "indexB"}},
  {Indexes: []string{"indexX", "indexY"}},
})

await client.SwapIndexesAsync(new List<IndexSwap> { new IndexSwap("indexA", "indexB"), new IndexSwap("indexX", "indexY") } });

client.swap_indexes([
  &SwapIndexes {
    indexes: (
        "indexA".to_string(),
        "indexB".to_string(),
    ),
  }, &SwapIndexes {
    indexes: (
        "indexX".to_string(),
        "indexY".to_string(),
    ),
}])

let task = try await self.client.swapIndexes([
  ("indexA", "indexB"),
  ("indexX", "indexY")
])

await client.swapIndexes([
  SwapIndex(['indexA', 'indexB']),
  SwapIndex(['indexX', 'indexY']),
]);

Response

{
  "taskUid": 3,
  "indexUid": null,
  "status": "enqueued",
  "type": "indexSwap",
  "enqueuedAt": "2021-08-12T10:00:00.000000Z"
}

Since indexSwap is a global task, the indexUid is always null.

You can use the response’s taskUid to track the status of your request.

API reference

Errors

Index object

List all indexes

Query parameters

Response

Example

Response: `200 Ok`

Get one index

Path parameters

Example

Response: `200 Ok`

Create an index

Body

Example

Response: `202 Accepted`

Update an index

Path parameters

Body

Example

Response: `202 Accepted`

Delete an index

Path parameters

Example

Response: `202 Accepted`

Swap indexes

Body

Example

Response

​Index object

​List all indexes

​Query parameters

​Response

​Example

​Response: 200 Ok

​Get one index

​Path parameters

​Example

​Response: 200 Ok

​Create an index

​Body

​Example

​Response: 202 Accepted

​Update an index

​Path parameters

​Body

​Example

​Response: 202 Accepted

​Delete an index

​Path parameters

​Example

​Response: 202 Accepted

​Swap indexes

​Body

​Example

​Response

Index object

List all indexes

Query parameters

Response

Example

Response: `200 Ok`

Get one index

Path parameters

Example

Response: `200 Ok`

Create an index

Body

Example

Response: `202 Accepted`

Update an index

Path parameters

Body

Example

Response: `202 Accepted`

Delete an index

Path parameters

Example

Response: `202 Accepted`

Swap indexes

Body

Example

Response