Skip to content
Nirvana LabsNirvana Labs API
Docs
    API Reference
    Compute

    Volumes

    Create Volume
    client.compute.volumes.create(VolumeCreateParams { name, project_id, region, 4 more } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    POST/v1/compute/volumes
    Get Volume
    client.compute.volumes.get(stringvolumeID, RequestOptionsoptions?): Volume { id, created_at, kind, 10 more }
    GET/v1/compute/volumes/{volume_id}
    Update Volume
    client.compute.volumes.update(stringvolumeID, VolumeUpdateParams { name, size, tags } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    PATCH/v1/compute/volumes/{volume_id}
    Delete Volume
    client.compute.volumes.delete(stringvolumeID, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    DELETE/v1/compute/volumes/{volume_id}
    List Volumes
    client.compute.volumes.list(VolumeListParams { project_id, cursor, limit } query, RequestOptionsoptions?): Cursor<Volume { id, created_at, kind, 10 more } >
    GET/v1/compute/volumes
    Attach Volume
    client.compute.volumes.attach(stringvolumeID, VolumeAttachParams { vm_id } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    POST/v1/compute/volumes/{volume_id}/attach
    Detach Volume
    client.compute.volumes.detach(stringvolumeID, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
    POST/v1/compute/volumes/{volume_id}/detach
    ModelsExpand Collapse
    Volume { id, created_at, kind, 10 more }

    Volume details.

    id: string

    Unique identifier for the Volume.

    created_at: string

    When the Volume was created.

    formatdate-time
    kind: VolumeKind

    Volume kind.

    One of the following:
    "boot"
    "data"
    name: string

    Name of the Volume.

    project_id: string

    Project ID the Volume belongs to.

    region: RegionName { }

    Region the resource is in.

    size: number

    Size of the Volume in GB.

    status: ResourceStatus

    Status of the resource.

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

    Tags to attach to the Volume.

    type: VolumeType

    Type of the Volume.

    One of the following:
    "nvme"
    "abs"
    updated_at: string

    When the Volume was updated.

    formatdate-time
    vm_id: string | null

    ID of the VM the Volume is attached to.

    vm_name: string | null

    Name of the VM the Volume is attached to.

    VolumeKind = "boot" | "data"

    Volume kind.

    One of the following:
    "boot"
    "data"
    VolumeList { items, pagination }
    items: Array<Volume { id, created_at, kind, 10 more } >
    id: string

    Unique identifier for the Volume.

    created_at: string

    When the Volume was created.

    formatdate-time
    kind: VolumeKind

    Volume kind.

    One of the following:
    "boot"
    "data"
    name: string

    Name of the Volume.

    project_id: string

    Project ID the Volume belongs to.

    region: RegionName { }

    Region the resource is in.

    size: number

    Size of the Volume in GB.

    status: ResourceStatus

    Status of the resource.

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

    Tags to attach to the Volume.

    type: VolumeType

    Type of the Volume.

    One of the following:
    "nvme"
    "abs"
    updated_at: string

    When the Volume was updated.

    formatdate-time
    vm_id: string | null

    ID of the VM the Volume is attached to.

    vm_name: string | null

    Name of the VM the Volume is attached to.

    VolumeType = "nvme" | "abs"

    Type of the Volume.

    One of the following:
    "nvme"
    "abs"

    VolumesAvailability

    Check Volume Create Availability
    client.compute.volumes.availability.create(AvailabilityCreateParams { name, project_id, region, 4 more } body, RequestOptionsoptions?): void
    POST/v1/compute/volumes/availability
    Check Volume Update Availability
    client.compute.volumes.availability.update(stringvolumeID, AvailabilityUpdateParams { name, size, tags } body, RequestOptionsoptions?): void
    PATCH/v1/compute/volumes/{volume_id}/availability

    VolumesCost

    Estimate Volume Create Cost
    client.compute.volumes.cost.create(CostCreateParams { name, project_id, region, 4 more } body, RequestOptionsoptions?): CostQuote { currency, monthly_total, priced_at, 3 more }
    POST/v1/compute/volumes/cost
    Estimate Volume Update Cost
    client.compute.volumes.cost.update(stringvolumeID, CostUpdateParams { name, size, tags } body, RequestOptionsoptions?): CostQuoteUpdate { after, before, currency, 4 more }
    PATCH/v1/compute/volumes/{volume_id}/cost