Skip to main content
POST
/
bot-orchestration
/
stop-bot
Stop Bot
curl --request POST \
  --url http://localhost:8000/bot-orchestration/stop-bot \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bot_name": "<string>",
  "skip_order_cancellation": false,
  "async_backend": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Action to stop a bot

​
bot_name
string
required

Name of the bot instance to act upon

​
skip_order_cancellation
boolean
default:false

Whether to skip cancelling open orders when stopping

​
async_backend
boolean
default:false

Whether to run in async backend mode

Response

Successful Response