STstarlink
Routers

Batch update sandbox clients

Required permission: Device command and configuration, Edit.<br/>Update the sandbox state for multiple clients. If sandboxing is enabled, sandboxed clients will only have access to domains in the sandbox domain allow list. If a client is duplicated, records the client with the latest expiry. An empty list does nothing and does not remove existing clients.

post/public/v2/routers/sandbox/clients

Request

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

Request body

clientIdstring required

Identifier of the client to add or remove from a sandbox.

sandboxIdinteger required

Identifier used to separate sandbox environments. Per-client sandboxing is shared within the same SandboxId.

expirystring date-time required

Expiry of the sandbox state as a UTC date time.

Response

Success

informationstring[] nullable
isValidboolean

Changes

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