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

    Type Alias PostVolumeData

    type PostVolumeData = {
        body: {
            config_id?: number;
            encryption?: "enabled" | "disabled";
            label: string;
            linode_id?: number;
            region?: string | null;
            size?: number;
            tags?: string[];
        };
        path?: never;
        query?: never;
        url: "volumes";
    }
    Index

    Properties

    Properties

    body: {
        config_id?: number;
        encryption?: "enabled" | "disabled";
        label: string;
        linode_id?: number;
        region?: string | null;
        size?: number;
        tags?: string[];
    }

    Type Declaration

    • Optionalconfig_id?: number

      When creating a volume attached to a Linode, this is the identifier of the Linode configuration profile (config) where the volume will live. Run the List configuration profiles operation and store the id for the applicable config. The following apply when adding a config_id:

      • The selected config needs to belong to the Linode referenced by linode_id in this request.

      • You can't provide a config_id if you don't also provide a linode_id in the request.

      • If you send a linode_id without a config_id in the request, the API attaches the volume to that Linode's last used config, or to the only config in that Linode. If there isn't a config available for attachment, the API returns an error.

    • Optionalencryption?: "enabled" | "disabled"

      Enables encryption on the volume. Full disk encryption ensures the data stored on a block storage volume drive is secure. It protects against unauthorized access by keeping the data encrypted if the volume drive is removed from the data center, decommissioned, or disposed of.

      The platform automatically manages the encryption and decryption process for you. You can use an encrypted volume the same way you use a non-encrypted volume.

      📘

      You can enable or disable disk encryption only when creating new block storage volumes. After a volume is created, the encryption setting can't be changed.

    • label: string

      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

      The Linode this volume should be attached to after it's created. If not given, the volume will be created without an attachment.

    • Optionalregion?: string | null

      The region where the API deploys the volume. This is only required if you didn't provide a linode_id for the volume.

    • Optionalsize?: number

      The initial size of this volume, in GB. Volumes can only be resized after the creation completes.

    • Optionaltags?: string[]

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

    path?: never
    query?: never
    url: "volumes"