Skip to main content
POST
Stop Executor

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: 'stopping', or 'already_terminated' when the stop was a no-op

keep_position
boolean
required

Whether position was kept open

close_type
string | null

Final close_type when already terminated

position_address
string | null

On-chain position address from the executor's final state, if any

orphaned_position
boolean
default:false

True when the executor terminated with a live on-chain position that needs recovery

hold_reason
string | null

Why a POSITION_HOLD terminal was involuntary (e.g. close_retries_exhausted); None for voluntary holds