Skip to content
DocsOpenAPI spec

    Sandbox Clusters

    Create Sandbox Cluster
    client.sandboxClusters.create(SandboxClusterCreateParams { instance_type, name, node_count, 3 more } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    POST/v1/sandbox_clusters
    Get Sandbox Cluster
    client.sandboxClusters.get(stringsandboxClusterID, RequestOptionsoptions?): SandboxCluster { id, created_at, gateway_hostname, 8 more }
    GET/v1/sandbox_clusters/{sandbox_cluster_id}
    Update Sandbox Cluster
    client.sandboxClusters.update(stringsandboxClusterID, SandboxClusterUpdateParams { name, tags } body, RequestOptionsoptions?): SandboxCluster { id, created_at, gateway_hostname, 8 more }
    PATCH/v1/sandbox_clusters/{sandbox_cluster_id}
    Delete Sandbox Cluster
    client.sandboxClusters.delete(stringsandboxClusterID, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    DELETE/v1/sandbox_clusters/{sandbox_cluster_id}
    List Sandbox Clusters
    client.sandboxClusters.list(SandboxClusterListParams { project_id, cursor, limit, 4 more } query, RequestOptionsoptions?): Cursor<SandboxCluster { id, created_at, gateway_hostname, 8 more } >
    GET/v1/sandbox_clusters
    ModelsExpand Collapse
    SandboxCluster { 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.

    formatdate-time
    gateway_hostname: string | null

    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: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    tags: Array<string>

    Tags attached to the Sandbox Cluster.

    updated_at: string

    When the Sandbox Cluster was last updated.

    formatdate-time
    SandboxClusterList { items, pagination }
    items: Array<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.

    formatdate-time
    gateway_hostname: string | null

    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: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    tags: Array<string>

    Tags attached to the Sandbox Cluster.

    updated_at: string

    When the Sandbox Cluster was last updated.

    formatdate-time

    Sandbox ClustersCost

    Estimate Sandbox Cluster Create Cost
    client.sandboxClusters.cost.create(CostCreateParams { instance_type, name, node_count, 3 more } body, RequestOptionsoptions?): CostQuote { currency, monthly_total, priced_at, 3 more }
    POST/v1/sandbox_clusters/cost