Sign in
Bot Orchestration

Stop And Archive Bot

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}

Path parameters

bot_namestring required

Query parameters

skip_order_cancellationboolean
archive_locallyboolean
s3_bucketstring

Response

Successful Response

{"stackTrail":"paths:/bot-orchestration/stop-and-archive-bot/{bot_name}:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 4 of the 13 revisions of this API.23

  • 92703f48a69e2See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2ad95b6a84b21See the full diff
    • ▲

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

      response-body-type-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 576ec8539f761See the full diff
    • ▲

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

      response-body-type-changed

  • 1005bcd472801See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog