Create a task

Creates a new task.

POST /2/tasks

curl

cURL

curl --request POST \
  --url https://data.us.algolia.com/2/tasks \
  --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 '{"sourceID":"6c02aeb1-775e-418e-870b-1faccd4b2c0f","destinationID":"6c02aeb1-775e-418e-870b-1faccd4b2c0f","action":"replace","subscriptionAction":"replace","cron":"* * 1 * *","enabled":true,"failureThreshold":0,"input":{"mapping":{"format":"mappingkit/v1","actions":[{"id":"lorem","enabled":true,"trigger":"lorem","fieldDirectives":[{"fieldKey":"lorem","value":{}}]}]}},"cursor":"lorem","notifications":{"email":{"enabled":true}},"policies":{"criticalThreshold":1}}'

200

{
  "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "createdAt": "<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.

Body

application/json

Request body for creating a task.

API request body for creating a task.

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"

action · enum<string> · required

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

cron · string

Cron expression for the task's schedule.

Example:

"* * 1 * *"

enabled · boolean

Whether the task is enabled.

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

Show child attributes

input. mapping · object · required

Transformations to apply to the source, serialized as a JSON string.

Show child attributes

input.mapping. format · enum<string> · required

Mapping format schema.

Available options: mappingkit/v1

input.mapping. actions · object[] · required

Show child attributes

input.mapping.actions. enabled · boolean · required

Whether this action has any effect.

input.mapping.actions. trigger · string · required

Condition which must be satisfied to apply the action. If this evaluates to false, the action is not applied, and the process attempts to apply the next action, if any.

input.mapping.actions. fieldDirectives · object[] · required

Show child attributes

input.mapping.actions.fieldDirectives. fieldKey · string · required

Destination field key.

input.mapping.actions.fieldDirectives. value · object · required

How the destination field should be resolved from the source.

input.mapping.actions. id · string

ID to uniquely identify this action.

cursor · string

Date of the last cursor in RFC 3339 format.

notifications · object

Notifications settings for a task.

Show child attributes

notifications. email · emailNotifications · object · required

Show child attributes

notifications.email. enabled · boolean

Whether to send email notifications, note that this doesn't prevent the task from being blocked.

policies · object

Set of rules for a task.

Show child attributes

policies. criticalThreshold · integer

The number of critical failures in a row before blocking the task and sending a notification.

Required range: 1 <= x <= 10

Response

200

application/json

OK

API response for creating a task.

taskID · string · required

Universally unique identifier (UUID) of a task.

Example:

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

createdAt · string · required

Date of creation in RFC 3339 format.