Skip to content
DocsOpenAPI spec

    Sandbox Clusters

    Create Sandbox Cluster
    $ nirvana sandbox-clusters create
    POST/v1/sandbox_clusters
    Get Sandbox Cluster
    $ nirvana sandbox-clusters get
    GET/v1/sandbox_clusters/{sandbox_cluster_id}
    Update Sandbox Cluster
    $ nirvana sandbox-clusters update
    PATCH/v1/sandbox_clusters/{sandbox_cluster_id}
    Delete Sandbox Cluster
    $ nirvana sandbox-clusters delete
    DELETE/v1/sandbox_clusters/{sandbox_cluster_id}
    List Sandbox Clusters
    $ nirvana sandbox-clusters list
    GET/v1/sandbox_clusters
    ModelsExpand Collapse
    sandbox_cluster: object { id, created_at, gateway_hostname, 8 more }

    A cluster sandboxes run on, in one region.

    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.

    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.

    Sandbox ClustersCost

    Estimate Sandbox Cluster Create Cost
    $ nirvana sandbox-clusters:cost create
    POST/v1/sandbox_clusters/cost