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: elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For example:
  • uat.elastic.snaplogic.com
  • emea.snaplogic.com
env_org Required. The name of the SnapLogic environment/Org. For example, My-Dev-Env
ruuid Required. The pipeline Runtime ID.
To find the Runtime ID:
  1. Open Monitor.
  2. From the navigation pane, select Pipeline executions.
  3. Search for the pipeline.
  4. Copy the value from the RUUID column. If the executions table doesn't contain the column, click the Table configuration and filters control and add it.

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

None.

Response

Status code only.