Stop a pipeline execution

POST /runtime/stop/{env_org}/{ruuid}

Overview

This API stops the pipeline execution with the specified Runtime ID.

Prerequisites

  • Write access to the assets to be added or updated

Request

 POST https://{controlplane_path}/api/1/rest/public/runtime/stop/{env_org}/{ruuid}

Path Parameters

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

Example: cdn.elastic.snaplogic.com

For other control planes, substitute the subdomain name for elastic. For example:
  • cdn.uat.snaplogic.com
  • cdn.emea.snaplogic.com
org Required. The name of the SnapLogic Environment/Org.
ruuid Required. The Runtime ID of the pipeline.
To get the Runtime ID of a running pipeline:
  1. Go to Dashboard > Pipeline.
  2. In the Executing Pipelines of All Projects list, click the pipeline you want.
  3. From the address bar of the web browser tab that displays the pipeline, copy the value of the parameter pipe_runtime_id.

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

None.

Response

Status code only.