Skip to main content
POST
/
tasks
/
compact
Compact task queue.
curl --request POST \
  --url http://localhost:7700/tasks/compact \
  --header 'Authorization: Bearer <token>'
{
  "preSize": "456 kiB",
  "postSize": "123 kiB",
  "status": "succeeded",
  "actionRequired": "you must restart your instance"
}

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

Response

Task queue compaction successfully completed.

​
status
enum<string>
required

Outcome of the compaction operation.

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

"processing"

​
preSize
string

Size of the task queue database before compaction.

​
postSize
string

Size of the task queue database after compaction.

​
actionRequired
string | null

Follow-up action required after a successful compaction.

​
errorMessage
string | null

Error message if compaction failed.