Change the Snaplex of a task

PATCH /task/plex

Overview

This API changes the Snaplex associated with a task.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 PATCH https://{controlplane_path}/api/1/rest/public/task/plex

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea

Query Parameters

None.

Request Header

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

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

 {
  "task_path": "...",
  "project_path": "...",
  "runtime_path_id": "..."
}
Key Type Description
task_path string The path to the specific task to be updated.

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

Important: The path comparison is case-sensitive.

If task_path and project_path are both provided, task_path takes precedence.

project_path string The path to the project to be updated. All tasks within the project are updated.

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

Important: The path comparison is case-sensitive.

If task_path and project_path are both provided, task_path takes precedence.

runtime_path_id

rt_path_id

string The identifier of the Snaplex.

Format: {org}/rt/{snaplex-location}/{snaplex-environment}

Response

Response Body

 {
  "success": [ ... ],
  "failed": [ ... ]
}
Key Type Description
success array An array of strings containing the paths to the tasks that were successfully updated.
failed array An array of strings containing the paths to the tasks that were not updated.