Enable a task
POST /task/enable
Overview
This API enables a task.
When disabled | When enabled again | |
---|---|---|
Ultra tasks | Instances are marked as complete. | Instances are restarted. |
Scheduled tasks on repeat schedule | Tasks do not run at future scheduled times. | Tasks start running again at scheduled times. |
Prerequisites
- Write permissions to update the task
Request
POST https://{controlplane_path}/api/1/rest/public/task/enable
Path Parameters
Key | Description |
---|---|
controlplane_path |
Required. The path to the SnapLogic Control Plane:
elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic . For
example:
|
Query Parameters
None.
Request Header
In the request header, specify Basic
for authorization, add your credentials, and specify application/json
for content type:
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request Body
Specify the task path to enable a single task. Specify the project path to enable all tasks within the project.
Note: If both
task_path
and project_path
are provided,
task_path
takes precedence and project_path
is ignored.
{
"task_path" : "...",
"project_path" : "..."
}
Key | Type | Description |
---|---|---|
task_path |
string | The path to the task.
Format: |
project_path |
string |
Required. The path to the SnapLogic project.
Format: Important: The path comparison is case-sensitive.
|
Response
Response Body
{
"success": [ ... ],
"failed": [ ... ]
}
Key | Type | Description |
---|---|---|
success |
array | An array of strings containing the paths of the tasks that were successfully updated. |
failed |
array | An array of strings containing the paths of the tasks that were not updated. |