Skip to main content
GET
/
v2
/
sandboxes
/
pools
List all Sandbox Pools
curl --request GET \
  --url https://api.example.com/v2/sandboxes/pools
{
  "pools": [
    {
      "name": "<string>",
      "template_name": "<string>",
      "replicas": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "offset": 0
}

Query Parameters

​
limit
integer
default:50

Maximum number of resources to return.

Required range: 1 <= x <= 500
​
offset
integer
default:0

Pagination offset. Pass this value to subsequent requests to fetch the next page of resources.

Required range: x >= 0

Response

Successful Response

Response model for listing Sandbox Pools.

​
pools
WarmPoolResponse · object[]
required
​
offset
integer
default:0

Pagination offset for the next page. 0 if no more results.