Update pagination settings

PATCH /indexes/{indexUid}/settings/pagination
Api key

Update the pagination configuration of an index.


If the provided index does not exist, it will be created.

Headers

  • Content-Type string Required

    Payload content-type

    Value is application/json.

Path parameters

  • indexUid string Required

    Index Unique Identifier

application/json

Body Required

  • maxTotalHits integer

    Define the maximum number of documents reachable for a search request. It means that with the default value of 1000, it is not possible to see the 1001st result for a search query.

    Default value is 1000.

Responses

  • • 202 application/json

    Accepted

  • • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
  • • 404

    Not Found

PATCH /indexes/{indexUid}/settings/pagination 
curl \
 -X PATCH https://example.meilisearch.com:7700/indexes/movies/settings/pagination \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"maxTotalHits":1000}'
Request example 
# Headers
Content-Type: application/json

# Payload
{
  "maxTotalHits": 1000
}
Response examples (202) 
{
  "taskUid": 0,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-01-01T09:39:00.000000Z"
}
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"
}