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

    Type Alias PostAddLinodeDiskData

    type PostAddLinodeDiskData = {
        body: {
            authorized_keys?: string[];
            authorized_users?: string[];
            filesystem?: "raw" | "swap" | "ext2" | "ext3" | "ext4" | "initrd";
            image?: string | null;
            label?: string;
            root_pass?: string;
            size: number;
            stackscript_data?: { [key: string]: unknown };
            stackscript_id?: number;
        };
        path: { linodeId: number };
        query?: never;
        url: "linode/instances/{linodeId}/disks";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        authorized_keys?: string[];
        authorized_users?: string[];
        filesystem?: "raw" | "swap" | "ext2" | "ext3" | "ext4" | "initrd";
        image?: string | null;
        label?: string;
        root_pass?: string;
        size: number;
        stackscript_data?: { [key: string]: unknown };
        stackscript_id?: number;
    }

    Disk object request.

    Type Declaration

    • Optionalauthorized_keys?: string[]

      Write-only A list of public SSH keys that will be automatically appended to the root user's ~/.ssh/authorized_keys file when deploying from an Image.

    • Optionalauthorized_users?: string[]

      Write-only A list of usernames for authorized users. Before you can add a user, it needs an SSH key assigned to its profile. See Add an SSH key for more information. If the usernames already have associated SSH keys, the keys will be appended to the root users ~/.ssh/authorized_keys file automatically when deploying from an image.

    • Optionalfilesystem?: "raw" | "swap" | "ext2" | "ext3" | "ext4" | "initrd"

      The disk's format or file system. A value of raw indicates no file system, just a raw binary stream. A value of swap indicates a Linux swap area. The values ext3 or ext4 represent these Linux journaling file systems. The value ext2 is the deprecated ext2 Linux file system. Finally, initrd indicates the disk is formatted as an uncompressed initial RAM disk.

      📘

      The ext2 file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, initrd is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.

    • Optionalimage?: string | null

      An Image ID to deploy the Linode Disk from.

      Run the List images operation with authentication to view all available Images. Official Linode Images start with linode/, while your Account's Images start with private/. Creating a disk from a Private Image requires read_only or read_write permissions for that Image. Run the Update a user's grants operation to adjust permissions for an Account Image.

    • Optionallabel?: string

      Filterable The name of the disk. This is for display purposes only.

    • Optionalroot_pass?: string

      Write-only This sets the root user's password on a newly created Linode Disk when deploying from an Image.

      • Required when creating a Linode Disk from an Image, including when using a StackScript.

      • Must meet a password strength score requirement that is calculated internally by the API. If the strength requirement is not met, you will receive a Password does not meet strength requirement error.

    • size: number

      Filterable The size of the Disk in MB.

      Images require a minimum size. Run the Get an image operation to view its size.

    • Optionalstackscript_data?: { [key: string]: unknown }

      This field is required only if the StackScript being deployed requires input data from the User for successful completion. See User Defined Fields (UDFs) for more details.

      This field is required to be valid JSON.

      Total length cannot exceed 65,535 characters.

    • Optionalstackscript_id?: number

      A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. A compatible image is required to use a StackScript. To get a list of available StackScript and their permitted Images, run List StackScripts. This field cannot be used when deploying from a Backup or a Private Image.

    path: { linodeId: number }

    Type Declaration

    • linodeId: number

      ID of the Linode to look up.

    query?: never
    url: "linode/instances/{linodeId}/disks"

    Settings

    Member Visibility

    On This Page

    Properties