Retrieve a task V1

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

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

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

The V1 task object. Use methods and types that don't contain the V1 suffix.

createdAt

string

required

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

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.

sourceID

string

required

Universally uniqud identifier (UUID) of a source.

Example:

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

taskID

string

required

Universally unique identifier (UUID) of a task.

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

updatedAt

string

required

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

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.

failureThreshold

integer

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

Required range: 0 <= x <= 100

input

Streaming input · object

Configuration of the task, depending on its type.

Streaming input
Docker streams
Shopify input

Show child attributes

notifications

object

Notifications settings for a task.

Show child attributes

policies

object

Set of rules for a task.

Show child attributes