@akamai/openapi-ts
    Preparing search index...

    Type Alias PutVolumeData

    type PutVolumeData = {
        body: {
            created?: string;
            encryption?: "enabled" | "disabled";
            filesystem_path?: string;
            hardware_type?: "hdd" | "nvme";
            id?: number;
            io_ready?: boolean;
            label?: string;
            linode_id?: number | null;
            linode_label?: string | null;
            region?: string;
            size?: number;
            status?: "creating" | "active" | "resizing" | "key_rotating";
            tags?: string[];
            updated?: string;
        } & { linode_id?: unknown; size?: unknown };
        path: { volumeId: number };
        query?: never;
        url: "volumes/{volumeId}";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        created?: string;
        encryption?: "enabled" | "disabled";
        filesystem_path?: string;
        hardware_type?: "hdd" | "nvme";
        id?: number;
        io_ready?: boolean;
        label?: string;
        linode_id?: number | null;
        linode_label?: string | null;
        region?: string;
        size?: number;
        status?: "creating" | "active" | "resizing" | "key_rotating";
        tags?: string[];
        updated?: string;
    } & { linode_id?: unknown; size?: unknown }

    Type Declaration

    • Optional Readonlycreated?: string

      Read-only When this volume was created.

    • Optionalencryption?: "enabled" | "disabled"

      Read-only Whether encryption is enabled on this volume.

    • Optional Readonlyfilesystem_path?: string

      Read-only The full file system path for the volume, based on its label. The path is /dev/disk/by-id/scsi-0Linode_Volume_label.

    • Optionalhardware_type?: "hdd" | "nvme"

      Read-only The storage type of this volume. This can be either hdd to emulate a hard disk drive for the volume, or nvme to emulate a non-volatile memory express solid state drive.

    • Optional Readonlyid?: number

      Read-only The unique identifier for the volume.

    • Optional Readonlyio_ready?: boolean

      Read-only Indicates whether the volume is successfully attached to a Linode and ready for read and write operations.

    • Optionallabel?: string

      Filterable The name of the volume. A label can be up to 32 characters long and contain alphanumeric characters, hyphens, and underscores. This value is also used in the volume's filesystem_path.

    • Optionallinode_id?: number | null

      The unique identifier of the Linode this volume is attached to, if applicable.

    • Optional Readonlylinode_label?: string | null

      Read-only The name of the Linode this volume is attached to, if applicable.

    • Optionalregion?: string

      The unique identifier for the region where the volume lives.

    • Optionalsize?: number

      The volume's size, in gigabytes.

    • Optionalstatus?: "creating" | "active" | "resizing" | "key_rotating"

      Read-only The current status of the volume. This can be one of:

      • creating. The API is creating the volume and it's not ready for use.

      • active. The volume is online and ready for use.

      • resizing. The volume's capacity is being upgraded.

      • key_rotating. The volume's encryption keys are being rotated to new values. Requests to resize, delete, or clone a volume fail during encryption key rotation.

    • Optionaltags?: string[]

      Filterable Any tags applied to this object. Use tags to label and organize your cloud computing resources.

    • Optional Readonlyupdated?: string

      Read-only When this volume was last updated.

    • Optional Readonlylinode_id?: unknown
    • Optional Readonlysize?: unknown
    path: { volumeId: number }

    Type Declaration

    • volumeId: number

      The unique identifier for the target volume. Run the List volumes operation and store the id for the target volume as your volumeId.

    query?: never
    url: "volumes/{volumeId}"

    Settings

    Member Visibility

    On This Page

    Properties