Start a Pipeline

PUT /api/v1.2/pipelines/<pipeline_id>/start

Use this API to start or run a streaming pipeline. When the pipeline is started, it is in the active state.


To start or run the streaming pipelines, you must have the access to run Spark commands.

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.

Request API Syntax

curl -i -X PUT<pipeline_id>/start -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json"

Sample API Request

curl -i -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json"