Skip to main content
POST
/
v1
/
projects
/
{projectId}
/
streaming-pipelines
/
{streamingPipelineId}
/
commands
Execute a streaming pipeline command
curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines/{streamingPipelineId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "START"
}
'
{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

a valid bearer token

Path Parameters

​
projectId
string<uuid>
required

The ID of the project that contains the streaming pipeline definition

​
streamingPipelineId
string<uuid>
required

The ID of the streaming pipeline definition to send the command to

Body

application/json

The command to send to the streaming agent to execute

​
command
enum<string>
required

The command to be sent to the streaming agent

Available options:
START,
STOP

Response

Successfully executed streaming pipeline command