Type Alias PostUploadImageResponses

Type Declaration

• image: {
      capabilities: string[];
      created: string;
      created_by: string;
      deprecated: boolean;
      description: string | null;
      eol: string | null;
      expiry: string | null;
      id: string;
      image_sharing:
          | {
              shared_by: { [key: string]: unknown }
              | null;
              shared_with: { sharegroup_count: number; sharegroup_list_url: string };
          }
          | {
              shared_by: {
                  sharegroup_id: number;
                  sharegroup_label: string;
                  sharegroup_uuid: string;
                  source_image_id: string
                  | null;
              };
              shared_with: { [key: string]: unknown }
              | null;
          };
      is_public: boolean;
      is_shared: true
      | false
      | "none";
      label: string;
      regions: {
          region: string;
          status:
              | "available"
              | "creating"
              | "pending"
              | "pending deletion"
              | "pending replication"
              | "replicating";
      }[];
      size: number;
      status: "creating"
      | "pending_upload"
      | "available";
      tags: string[];
      total_size: number;
      type: "manual" | "automatic" | "shared";
      updated: string;
      vendor: string | null;
  }

  Image object.

  • Readonlycapabilities: string[]

    Read-only A list of the possible capabilities of this image.

    • cloud-init. The image supports the cloud-init multi-distribution method with our Metadata service. This only applies to public images.

    • distributed-sites. Whether the image can be used in distributed compute regions. Compared to a core compute region, distributed compute regions offer limited functionality, but they're globally distributed. Your image can be geographically closer to you, potentially letting you deploy it quicker. See Regions and images for complete details.

  • Readonlycreated: string

    Read-only When this image was created.

  • Readonlycreated_by: string

    Read-only The name of the user who created this image, or linode for public images.

  • Readonlydeprecated: boolean

    Filterable, Read-only A true value indicates a deprecated image. Only public images can be deprecated.

  • description: string | null

    A detailed description of this image.

  • Readonlyeol: string | null

    Read-only The time of the public image's planned removal from service. This is null for private images.

  • Readonlyexpiry: string | null

    Read-only Only images created automatically from a deleted compute instance (type=automatic) expire. This is null for private images.

  • Readonlyid: string

    Read-only The unique identifier for each image.

  • image_sharing:
        | {
            shared_by: { [key: string]: unknown }
            | null;
            shared_with: { sharegroup_count: number; sharegroup_list_url: string };
        }
        | {
            shared_by: {
                sharegroup_id: number;
                sharegroup_label: string;
                sharegroup_uuid: string;
                source_image_id: string
                | null;
            };
            shared_with: { [key: string]: unknown }
            | null;
        }

    Details about image sharing.

  • Readonlyis_public: boolean

    Filterable, Read-only A true value if the image is a public distribution image. A false value indicates private, account-specific images.

  • is_shared: true | false | "none"

    Filterable, Read-only A true value for shared private images. none for images shared within a group.

  • label: string

    Filterable A short description of the image.

  • Readonlyregions: {
        region: string;
        status:
            | "available"
            | "creating"
            | "pending"
            | "pending deletion"
            | "pending replication"
            | "replicating";
    }[]

    Read-only Details on the regions where this image is stored. See Regions and images for full details on support for regions.

  • Readonlysize: number

    Filterable, Read-only The minimum size in MB this image needs to deploy.

  • status: "creating" | "pending_upload" | "available"

    Filterable, Read-only The current status of the image. Possible values are available, creating, and pending_upload.

    📘

    The +order_by and +order operators are not available when filtering on this key.

  • tags: string[]

    Filterable Tags used for organizational purposes. A tag can be from 3 to 100 characters long, and an image can have a maximum of 500 total tags.

  • Readonlytotal_size: number

    Read-only The total size in bytes of all instances of this image, in all regions.

    📘

    This object is empty for existing images. It's intended for use with future functionality.

  • type: "manual" | "automatic" | "shared"

    Filterable, Read-only How the image was created. Create a manual image at any time. An automatic image is created automatically from a deleted compute instance. Other users within share groups can access a shared image.

  • Readonlyupdated: string

    Read-only When this image was last updated.

  • Readonlyvendor: string | null

    Filterable, Read-only The upstream distribution vendor. This is null for private images.

• upload_to: string

  The URL to upload the Image to.