Skip to main content
POST
/
executors
/
{executor_id}
/
stop
Stop Executor
curl --request POST \
  --url http://localhost:8000/executors/{executor_id}/stop \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keep_position": false
}
'
{
  "executor_id": "<string>",
  "status": "<string>",
  "keep_position": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
executor_id
string
required

Body

application/json

Request to stop an executor.

​
keep_position
boolean
default:false

Whether to keep the position open (for position executors)

Response

Successful Response

Response after stopping an executor.

​
executor_id
string
required

Executor identifier

​
status
string
required

New status (usually 'stopping')

​
keep_position
boolean
required

Whether position was kept open