Skip to content
Nirvana LabsNirvana Labs API
Docs
    API Reference

    Regions

    Get Region
    client.regions.get(stringname, RequestOptionsoptions?): Region { availability, compute, name, 3 more }
    GET/v1/regions/{name}
    List Regions
    client.regions.list(RegionListParams { cursor, limit } query?, RequestOptionsoptions?): Cursor<Region { availability, compute, name, 3 more } >
    GET/v1/regions
    ModelsExpand Collapse
    Region { availability, compute, name, 3 more }

    Region response with product availability.

    availability: RegionAvailability

    Availability status of the region.

    One of the following:
    "live"
    "preview"
    "maintenance"
    "sunset"
    compute: Compute { vms }

    Compute products available in this region.

    vms: boolean

    VMs indicates if Virtual Machines are available.

    name: string

    Name of the region.

    networking: Networking { connect, vpcs }

    Networking products available in this region.

    connect: boolean

    Connect indicates if Nirvana Connect is available.

    vpcs: boolean

    VPCs indicates if Virtual Private Clouds are available.

    nks: NKS { autoscaling, clusters }

    NKS products available in this region.

    autoscaling: boolean

    Autoscaling indicates if NKS node pool autoscaling is available.

    clusters: boolean

    Clusters indicates if NKS managed Kubernetes clusters are available.

    storage: Storage { abs, local_nvme }

    Storage products available in this region.

    abs: boolean

    ABS indicates if Accelerated Block Storage is available.

    local_nvme: boolean

    LocalNVMe indicates if locally-attached NVMe storage is available.

    RegionAvailability = "live" | "preview" | "maintenance" | "sunset"

    Availability status of the region.

    One of the following:
    "live"
    "preview"
    "maintenance"
    "sunset"
    RegionList { items, pagination }
    items: Array<Region { availability, compute, name, 3 more } >
    availability: RegionAvailability

    Availability status of the region.

    One of the following:
    "live"
    "preview"
    "maintenance"
    "sunset"
    compute: Compute { vms }

    Compute products available in this region.

    vms: boolean

    VMs indicates if Virtual Machines are available.

    name: string

    Name of the region.

    networking: Networking { connect, vpcs }

    Networking products available in this region.

    connect: boolean

    Connect indicates if Nirvana Connect is available.

    vpcs: boolean

    VPCs indicates if Virtual Private Clouds are available.

    nks: NKS { autoscaling, clusters }

    NKS products available in this region.

    autoscaling: boolean

    Autoscaling indicates if NKS node pool autoscaling is available.

    clusters: boolean

    Clusters indicates if NKS managed Kubernetes clusters are available.

    storage: Storage { abs, local_nvme }

    Storage products available in this region.

    abs: boolean

    ABS indicates if Accelerated Block Storage is available.

    local_nvme: boolean

    LocalNVMe indicates if locally-attached NVMe storage is available.