Updates

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

Get an update status

GET

/indexes/:index_uid/updates/:updateId

Get the status of an update in a given index.

Path Variables

Example

$ curl \
  -X GET 'http://localhost:7700/indexes/movies/updates/1'

client.index('movies').getUpdateStatus(1)

client.index('movies').get_update_status(1)

$client->index('movies')->getUpdateStatus(1);

index.get_update_status(1)

client.Updates("movies").Get(0)

let status: Status = progress.get_status().await.unwrap();

Response: 200 Ok

Here is an example response of an update that has 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

/indexes/:index_uid/updates

Get the status of all updates in a given index.

Path Variables

Example

$ curl \
  -X GET 'http://localhost:7700/indexes/movies/updates'

client.index('movies').getAllUpdateStatus()

client.index('movies').get_all_update_status()

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

index.get_all_update_status

client.Updates("movies").List()

// unavailable for now

Response: 200 Ok

Here is an example response of updates that have 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"
  }
]