---
title: "Batch update sandbox clients"
method: POST
path: "/public/v2/routers/sandbox/clients"
tags: ["Routers"]
---

# Batch update sandbox 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

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.

## Request body

- UpdateBatchSandboxClientRequest[]
  - `clientId` string, required: Identifier of the client to add or remove from a sandbox.
  - `sandboxId` integer, required: Identifier used to separate sandbox environments. Per-client sandboxing is shared within the same SandboxId.
  - `expiry` string, date-time, required: Expiry of the sandbox state as a UTC date time.

## Response `200`

Success

- ServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean

## Other responses

- `400`: Bad request. Invalid or missing parameter
- `401`: Unauthorized
- `403`: Missing required permission for this endpoint or resource
- `422`: Failed to update sandbox clients

---

[API](https://skmtc.dev/starlink/apis/starlink-management-api.md) - [All operations](https://skmtc.dev/starlink/apis/starlink-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/starlink/apis/starlink-management-api/revisions/dfd7014cfd6d?raw)
