Sandboxes

Get a sandbox

get/sandboxes/{id}

Path parameters

idstring required

24-char hex id of the sandbox.

Response

Sandbox detail

messagestring required

Example response

{
  "message": "Sandbox fetched",
  "data": {
    "region": {
      "id": "6a06df21cc6bef51342e199e",
      "name": "eu-west",
      "country": "France",
      "continent": "Europe"
    },
    "egress": {
      "mode": "restricted",
      "allow": [
        "1.1.1.1",
        "api.example.com"
      ]
    }
  }
}

Changes

Changed in 3 of the 5 revisions of this API.114

Jun 29, 20265ccf3b198b825See the full diff
- ○
  the response property data/auto_destroy became required for the status 200
  response-property-became-required
- ○
  the response property data/block_outbound became required for the status 200
  response-property-became-required
- ○
  the response property data/egress became required for the status 200
  response-property-became-required
- ○
  the response property data/one_shot became required for the status 200
  response-property-became-required
- ○
  the response property data/persistent became required for the status 200
  response-property-became-required
Jun 29, 20264a016f074bc02See the full diff
- ○
  added the optional property data/egress to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/network_updated to the response with the 200 status
  response-optional-property-added
May 23, 2026b236bf76f9a717See the full diff
- ▲
  the data/region response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ○
  removed RegionSummary subschema #2 from the data/region response property oneOf list for the response status 200
  response-property-one-of-removed
- ○
  added the required property data/region/continent to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/region/country to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/region/enabled to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/region/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/region/name to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/region/type to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history