- API Reference
- Box API
- System settings
Change how often the VPS relay connection is checked
Use this to set the VPS relay monitoring interval. The value must be greater than 5 seconds and applies at once. A missing or non-numeric value fails with HTTP 500.
POST
/v2/set_monitor_timeRequest body application/json · required
monitor_timeintegerrequired
Responses
Result.
statusbooleanrequired
True when the box accepted the request.
msgstringrequired
Outcome code or message (see the operation's error table).
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Unhandled error, for example a non-integer position or a missing required parameter.
errorstringoptional
Error name, e.g. internal_server_error or bad_request.
messagestringoptional
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
Configuration Failed! Please set monitoring time greater 5 seconds! | Value is 5 or less. | Send 6 or more. |