Bot Orchestration

Stop And Archive Bot

Changed on

Gracefully stop a bot and archive its data in the background. This initiates a background task that will:

  1. Stop the bot trading process via MQTT
  2. Wait 15 seconds for graceful shutdown
  3. Monitor and stop the Docker container
  4. Archive the bot data (locally or to S3)
  5. Remove the container

Returns immediately with a success message while the process continues in the background.

post/bot-orchestration/stop-and-archive-bot/{bot_name}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/bot-orchestration/stop-and-archive-bot/{bot_name}
  • Auth
    HTTP basic

Path parameters

bot_namestring required

Query parameters

skip_order_cancellationboolean
archive_locallyboolean
s3_bucketstring

Response

Successful Response

unknown required

Changes

  • 92703f48a69eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 2ad95b6a84b2Revision changes
    • breaking

      the response's body type changed from object to no type for status