Commands › Bot & webhooks
status
Check that the bot is online and where it is
Usage
curl -X POST "https://api.lifebots.cloud/api/bot.html" \
-H "Content-Type: application/json" \
-d '{
"action": "status",
"apikey": "YOUR_API_KEY",
"botname": "Joe Resident",
"secret": "bot-secret-123",
"dataType": "json"
}' Every request also needs apikey, botname and secret — see Authentication.
Parameters
None besides authentication.
Returns
| Field | Type | Description |
|---|---|---|
status | string | Always ONLINE when the call succeeds. |
slname | string | The bot's name. |
uuid | UUID | The bot's avatar UUID. |
location | string | Region/x/y/z, with unrounded coordinates. |
Example response
{
"result": "OK",
"status": "ONLINE",
"online": "1",
"slname": "Joe Resident",
"uuid": "a2e76fcd-9360-4f6d-a924-000000000000",
"location": "Sandbox Island/128.42/127.9/25.03"
} With dataType=json. A failure has result: "FAIL" and the reason in resulttext — see Responses & errors.
Good to know
- An offline bot does not report OFFLINE — the call fails with "Bot not connected on this channel".