Retrieve a task

Retrieves a task by its ID.

GET /2/tasks/{taskID}

curl

cURL

curl --request GET \
  --url https://data.us.algolia.com/2/tasks/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

{
  "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "enabled": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "cron": "* * 1 * *",
  "lastRun": "<string>",
  "nextRun": "<string>",
  "owner": "<string>",
  "input": {
    "mapping": {
      "format": "mappingkit/v1",
      "actions": [
        {
          "enabled": true,
          "trigger": "<string>",
          "fieldDirectives": [
            {
              "fieldKey": "<string>",
              "value": {}
            }
          ],
          "id": "<string>"
        }
      ]
    }
  },
  "failureThreshold": 50,
  "action": "replace",
  "subscriptionAction": "replace",
  "cursor": "<string>",
  "notifications": {
    "email": {
      "enabled": true
    }
  },
  "policies": {
    "criticalThreshold": 5
  }
}

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

taskID · string · required

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

Example:

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

Response

200

application/json

OK

taskID · string · required

Universally unique identifier (UUID) of a task.

Example:

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

sourceID · string · required

Universally uniqud identifier (UUID) of a source.

Example:

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

destinationID · string · required

Universally unique identifier (UUID) of a destination resource.

Example:

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

enabled · boolean · default: true · required

Whether the task is enabled.

createdAt · string · required

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

updatedAt · string · required

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

cron · string

Cron expression for the task's schedule.

Example:

"* * 1 * *"

lastRun · string

The last time the scheduled task ran in RFC 3339 format.

nextRun · string

The next scheduled run of the task in RFC 3339 format.

owner · string | null

Owner of the resource.

input · Streaming input · object

Configuration of the task, depending on its type.

Streaming input

Docker streams

Shopify input

Show child attributes

failureThreshold · integer

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

Required range: 0 <= x <= 100

action · enum<string>

Action to perform on the Algolia index.

Available options: replace, save, partial, partialNoCreate, append

subscriptionAction · enum<string>

Action to perform on the Algolia index.

Available options: replace, save, partial, partialNoCreate, append

cursor · string

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

notifications · object

Notifications settings for a task.

Show child attributes

policies · object

Set of rules for a task.

Show child attributes