Skip to content
DocsOpenAPI spec

    List Sandbox Clusters

    $ nirvana sandbox-clusters list
    GET/v1/sandbox_clusters

    List the Sandbox Clusters in a project

    ParametersExpand Collapse
    --project-id: string

    Project ID of resources to request

    --cursor: optional string

    Pagination cursor returned by a previous request. Only valid for the same sort order.

    --limit: optional number

    Maximum number of items to return

    --name: optional string

    Filter by a case-insensitive substring of the Sandbox Cluster name

    --region: optional string

    Filter by region

    --sort: optional string

    Comma-separated sort terms in precedence order, each field:asc or field:desc. Fields: created_at, updated_at

    --tag: optional array of string

    Filter by tags. Repeat the parameter to require several tags; a Sandbox Cluster must carry all of them.

    ReturnsExpand Collapse
    sandbox_cluster_list: object { items, pagination }
    items: array of SandboxCluster { id, created_at, gateway_hostname, 8 more }
    id: string

    Unique identifier for the Sandbox Cluster.

    created_at: string

    When the Sandbox Cluster was created.

    gateway_hostname: string

    Hostname sandboxes’ endpoints are served on over HTTPS, to allow in outbound firewalls. Null until assigned; a recreated Sandbox Cluster gets a new one.

    instance_type: string

    Instance type of the nodes the sandboxes run on.

    name: string

    Name of the Sandbox Cluster.

    node_count: number

    Number of nodes the sandboxes run on.

    project_id: string

    ID of the project the Sandbox Cluster is in.

    region: "us-sva-2" or "us-wdc-1"

    Region the resource is in.

    "us-sva-2"
    "us-wdc-1"
    status: "pending" or "creating" or "updating" or 5 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    tags: array of string

    Tags attached to the Sandbox Cluster.

    updated_at: string

    When the Sandbox Cluster was last updated.

    List Sandbox Clusters

    nirvana sandbox-clusters list \
      --api-key 'My API Key' \
      --project-id project_id
    {
      "items": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2025-01-01T00:00:00Z",
          "gateway_hostname": "gw.0123456789ab.example.com",
          "instance_type": "n1-standard-8",
          "name": "my-sandboxes",
          "node_count": 3,
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "us-sva-2",
          "status": "ready",
          "tags": [
            "production",
            "agents"
          ],
          "updated_at": "2025-01-01T00:00:00Z"
        }
      ],
      "pagination": {
        "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
        "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
        "total_count": 125
      }
    }
    Returns Examples
    {
      "items": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2025-01-01T00:00:00Z",
          "gateway_hostname": "gw.0123456789ab.example.com",
          "instance_type": "n1-standard-8",
          "name": "my-sandboxes",
          "node_count": 3,
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "region": "us-sva-2",
          "status": "ready",
          "tags": [
            "production",
            "agents"
          ],
          "updated_at": "2025-01-01T00:00:00Z"
        }
      ],
      "pagination": {
        "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
        "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
        "total_count": 125
      }
    }