Disable a Task

This page is no longer maintained (Mar 29, 2023). For the most current information, go to Disable a task.

 

POST /task/disable

Overview

This API enables a task.

 

When disabled

When enabled again

 

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

  • Org Admin permissions

Request

Path Parameters

Key

Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

If both task_path and project_path are provided, task_path has precedence and project_path is ignored.

{ "task_path" : ..., "project_path" : ... }

Key

Type

Description

Key

Type

Description

task_path

string

The path to the task.

Format: /{org}/{project_space}/{project_name}/{task_name}

project_path

string

Required. The path to the SnapLogic project.

Format: /{org}/{project_space}/{project_name}

Important: The path comparison is case-sensitive.