Disable a task

POST /task/disable

Overview

This API disables 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/disable

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:
  • uat.elastic.snaplogic.com
  • emea.snaplogic.com

Query parameters

None.

Request header

Basic authentication

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json

Example of Basic authenthication using Postman

Request body

Specify the task path to disable a single task. Specify the project path to disable 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: /{env_org}/{project_space}/{project_name}/{task_name}
project_path string
Required. The path to the SnapLogic project.

Format: /{env_org}/{project_space}/{project_name}

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.