Set the usage report
/api/settings/cloudTurn the usage report to Modbot Cloud on or off. It is on when Modbot is installed. Off stops the report every six hours; the switches for sending Modbot's log and for listing public instances are separate. Writes a settings-changed entry to the audit log.
Needs the ManageSettings permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
curl -X PUT "https://example.com/api/settings/cloud" \ -H "Content-Type: application/json" \ -d '{ "reportOn": true }'{ "disabled": true, "endpoint": "string", "registered": true, "lastReportAt": null, "lastReportOk": null, "lastReportProblem": null, "reportOn": true}Get Cloud status GET
Whether this server reports to Modbot Cloud, and how the last report went. `reportOn` is the usage report switch; `disabled` is `MODBOT_CLOUD_DISABLED`, which stops the report whatever the switch says. Needs the `ManageSettings` permission.
Create a link code POST
A code to type into Modbot Cloud to claim this server. The code is shown once and is not stored here. Modbot Cloud is told only its SHA-256, over this server's own authenticated connection, so Cloud never calls back to an address it was given. Needs the `ManageSettings` permission.