updates.md

Updates

The updates route gives information about the progress of the asynchronous processes.

Get an update status

Get the status of an update in a given index.

Path Variables

Variable	Description
index_uid	The index UID
updateId	The update identifier

Example

Response: 200 Ok

Here is an example response representing an update that has already been processed.

{
  "status": "processed",
  "updateId": 1,
  "type": {
    "name": "DocumentsAddition",
    "number": 4
  },
  "duration": 0.076980613,
  "enqueuedAt": "2019-12-07T21:16:09.623944Z",
  "processedAt": "2019-12-07T21:16:09.703509Z"
}

Get all update status

Get the status of all updates in a given index.

Path Variables

Variable	Description
index_uid	The index UID

Example

Response: 200 Ok

Here is an example response representing an enqueued update.

[
    {
        "status": "enqueued",
        "updateId": 0,
        "type": {
            "name": "DocumentsAddition",
            "number": 30
        },
        "enqueuedAt": "2021-02-14T14:07:09.364505700Z"
    }
]