Type Alias PutSharegroupImageshareResponses

Type Declaration

• Readonlycapabilities: string[]

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

• Readonlycreated: string

  Read-only When this image was shared.

• Readonlycreated_by: string | null

  Read-only The shared image creator's username.

• Readonlydeprecated: boolean

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

• description: string

  The shared image's detailed description.

• Readonlyeol: string | null

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

• Readonlyexpiry: string | null

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

• Readonlyid: string

  Read-only The shared image’s unique slug identifier.

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

  Read-only The image's sharing details, including the share group and source image data.

  • shared_by: {
        sharegroup_id: number;
        sharegroup_label: string;
        sharegroup_uuid: string;
        source_image_id: string;
    }

    • Readonlysharegroup_id: number

      Read-only The share group's numeric identifier, used primarily as path parameters in URLs.

    • sharegroup_label: string

      The share group's descriptive name.

    • Readonlysharegroup_uuid: string

      Read-only The share group's unique identifier used for membership token management.

    • Readonlysource_image_id: string

      Read-only The source image's slug identifier.

  • shared_with: { [key: string]: unknown } | null

    The share group's and source image details.

• Readonlyis_public: boolean

  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"

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

• label: string

  The shared image's name.

• 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

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

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

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

• Readonlytags: string[]

  Read-only The shared image's organizational tags. A tag can be from 3 to 100 characters long, and each image can include up to 500 tags.

• Readonlytotal_size: number

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

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

  Read-only Indicates how the image was created. It's always shared for images in a shared group. An automatic image is created automatically from a deleted compute instance. Other users within share groups can access a shared image.

• Readonlyupdated: string | null

  Read-only When this shared image was last updated.

• Readonlyvendor: string | null

  Read-only The upstream distribution vendor, null for private and shared images.