Skip to navigation
Bot Endpoints

Get Stop Status

View as Markdown

Check the progress of a stop request without stopping the bot again: requested, acknowledged, stopped, force-stopped or failed.

Authentication

AuthorizationToken

Format: Token <your_api_key>

Path parameters

bot_idstringRequired

Response

Success
bot_idstringOptional
statusenumOptional
State of the stop request.
bot_statusstringOptional

The bot's own lifecycle status, or Unknown.

control_request_idstringOptional
Id of the stop request, once one has been issued.
requested_atintegerOptional
Unix epoch seconds.
acknowledged_atintegerOptional
Unix epoch seconds.
completed_atintegerOptional
Unix epoch seconds.
reasonstringOptional

Errors

404
Not Found Error