Search for tasks V1

Searches for tasks using the v1 endpoint. Use searchTasks instead.

POST /1/tasks/search

curl

cURL

curl --request POST \
  --url https://data.us.algolia.com/1/tasks/search \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '
{
  "taskIDs": [
    "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
  ]
}
'

200

[
  {
    "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    "destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
    "trigger": {
      "type": "onDemand",
      "lastRun": "<string>"
    },
    "enabled": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "input": {
      "mapping": {
        "format": "mappingkit/v1",
        "actions": [
          {
            "enabled": true,
            "trigger": "<string>",
            "fieldDirectives": [
              {
                "fieldKey": "<string>",
                "value": {}
              }
            ],
            "id": "<string>"
          }
        ]
      }
    },
    "failureThreshold": 50,
    "action": "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.

Body

application/json

taskIDs · string[] · required

Universally unique identifier (UUID) of a task.

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"

trigger · object · required

Trigger that runs the task.

Option 1

Option 2

Option 3

Option 4

Show child attributes

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.

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

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