Retrieve a task run

Retrieve a single task run by its ID.

GET /1/runs/{runID}

curl

cURL

curl --request GET \
  --url https://data.us.algolia.com/1/runs/6c02aeb1-775e-418e-870b-1faccd4b2c0f \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "appID": "<string>",
  "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "status": "created",
  "type": "reindex",
  "createdAt": "<string>",
  "progress": {
    "expectedNbOfEvents": 123,
    "receivedNbOfEvents": 123
  },
  "outcome": "success",
  "failureThreshold": 50,
  "reason": "<string>",
  "reasonCode": "internal",
  "startedAt": "<string>",
  "finishedAt": "<string>"
}

Required ACL: addObject, deleteIndex, editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

runID · string · required

Unique identifier of a task run. Universally unique identifier (UUID) of a task run.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

Response

200

application/json

OK

runID · string · required

Universally unique identifier (UUID) of a task run.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

appID · string · required

taskID · string · required

Universally unique identifier (UUID) of a task.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

status · enum<string> · required

Task run status.

Available options: created, started, finished, skipped

type · enum<string> · required

Task run type.

Available options: reindex, update, discover, validate, push

createdAt · string · required

Date and time when the resource was created, in RFC 3339 format.

progress · runProgress · object

Show child attributes

outcome · enum<string>

Task run outcome.

Available options: success, failure

failureThreshold · integer

Maximum accepted percentage of failures for a task run to finish successfully.

Required range: 0 <= x <= 100

reason · string

More information about the task run's outcome.

reasonCode · enum<string>

A code for the task run's outcome. A readable description of the code is included in the reason response property.

Available options: internal, cancelled, critical, no_events, too_many_errors, lacking_events, ok, blocking, idle

startedAt · string

Date and time when the task started, in RFC 3339 format.

finishedAt · string

Date and time when the task finished, in RFC 3339 format.