Skip to content

Stop Pipeline

POST
/api/v1/pipelines/{pipeline_id}/stop
curl --request POST \
--url https://example.com/api/v1/pipelines/example/stop

Stop a running pipeline.

pipeline_id
required
Pipeline Id
string
X-Environment-Id
Any of:
string

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}