Pause a Pipeline¶

PUT /api/v1.2/pipelines/<pipeline_id>/pause¶

Use the API to pause a streaming pipeline. When the pipeline is paused, it is in the inactive state.

Required Role¶

The following users can make this API call:

Users who belong to the system-user or system-admin group.
Users who belong to a group associated with a role that allows submitting a command.
Users who belong to a role that allows the Pipelines resource.

See Managing Groups and Managing Roles for more information.

Parameters¶

Note

Parameters marked in bold below are mandatory. Others are optional and have default values.

Parameter	Description
test_run	Possible values:`true` or `false`. Set the value to `true` if you want to pause the test run of a pipeline.

Request API Syntax¶

curl -i -X PUT https://api.qubole.com/api/v1.2/pipelines/<pipeline_id>/pause -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json"
 -d '
     {
         "test_run":<true-or-false>
     }

Sample API Request¶

The following example shows how to pause the test run of a pipeline.

curl -i -X PUT https://api.qubole.com/api/v1.2/pipelines/1/pause -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json


     {
         "test_run":true
     }