Indexes

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

Learn more about indexes.

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

Example

curl \
  -X GET 'http://localhost:7700/indexes?limit=3'

client.getIndexes({ limit: 3 })

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

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

client.getIndexes();

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(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. The index uid is required.

Example

curl \
  -X GET 'http://localhost:7700/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. This endpoint accepts two arguments: uid and primaryKey.

If you do not supply a value for primaryKey, Meilisearch will try to infer your dataset's unique identifier from the first document you add to the index.

NOTE

If you try to add documents or settings to an index that does not exist, Meilisearch will automatically create it for you. This is called implicit index creation.

Creating an index is an asynchronous task. You can read more about asynchronous operations in our dedicated guide.

Body

Variable	Description
uid	The index unique identifier (mandatory)
primaryKey	The primary key of the documents

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

Example

curl \
  -X POST 'http://localhost:7700/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. The index uid is required.

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 finally, index your dataset again.

NOTE

It is not possible to change an index's uid.

This is an asynchronous task. You can read more about asynchronous operations in our dedicated guide.

Body

Variable	Description
primaryKey	The primary key of the documents

Example

curl \
  -X PATCH 'http://localhost:7700/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']);
// OR
$client->index('movies')->update(['primaryKey' => 'id']);

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

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

client.Index("movies").UpdateIndex("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:
        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. The index uid is required.

This is an asynchronous task. You can read more about asynchronous operations in our dedicated guide.

Example

curl \
  -X DELETE 'http://localhost:7700/indexes/movies'

client.deleteIndex('movies')

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

$client->deleteIndex('movies');
// OR
$client->index('movies')->delete();

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:
        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.