Skip to main content
GET
/
1
/
runs
/
{runID}
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'
{
  "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "appID": "<string>",
  "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "status": "created",
  "progress": {
    "expectedNbOfEvents": 123,
    "receivedNbOfEvents": 123
  },
  "outcome": "success",
  "failureThreshold": 50,
  "reason": "<string>",
  "reasonCode": "internal",
  "type": "reindex",
  "createdAt": "<string>",
  "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.

Example:

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

Response

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,
idled,
finished,
skipped
​
type
enum<string>
required

Task run type.

Available options:
reindex,
update,
discover,
validate,
push
​
createdAt
string
required

Date of creation in RFC 3339 format.

​
progress
object
​
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,
critical,
no_events,
too_many_errors,
ok,
discarded,
blocking
​
startedAt
string

Date of start in RFC 3339 format.

​
finishedAt
string

Date of finish in RFC 3339 format.

⌘I