STstarlink
Routers

Update sandbox heartbeat

Required permission: Device command and configuration, Edit.<br/>Heartbeats verify the health of enterprise systems that manage router sandboxing. If heartbeats are not received for an account, Starlink API will instruct routers under the account disable sandboxes until reboot.

put/public/v2/routers/sandbox/heartbeat

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/routers/sandbox/heartbeat
  • Auth
    HTTP bearer

Request body

healthyboolean required

True if client systems are healthy, false otherwise.

Response

Success

informationstring[] nullable
isValidboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.