OBJECT

Image

An image contains the software packages that will be available on newly-provisioned instance. In the case of hardware virtual machines, the image also includes the operating system

link GraphQL Schema definition

  • type Image {
  • # Unique id for this image
  • id: ID
  • # The "friendly" name for this image'
  • name: String
  • # The underlying operating system for this image'
  • os: ImageOS
  • # The version for this image'
  • version: String
  • # A short prose description of this image
  • description: String
  • # What kind of image this is. The values differ after v8.0.0+
  • type: ImageType
  • # Contains a grouping of various minimum requirements for provisioning an instance
  • # with this image. For example "password" indicates that a password must be
  • # provided
  • requirements: ImageRequirements
  • # The URL for a web page with more detailed information for this image
  • homepage: String
  • # An array of image files that make up each image. Currently only a single file
  • # per image is supported
  • files: [ImageFile]
  • # The time this image has been made publicly available
  • published_at: String
  • # The UUID of the user who owns this image
  • owner: ID
  • # Indicates if this image is publicly available
  • public: Boolean
  • # The current state of the image. One of "active", "unactivated", "disabled",
  • # "creating", "failed"
  • state: ImageState
  • # An object of key/value pairs that allows clients to categorize images by any
  • # given criteria
  • tags: [KeyValue]
  • # URL of the End User License Agreement (EULA) for the image
  • eula: String
  • # Access Control List. An array of account UUIDs given access to a private image.
  • # The field is only relevant to private images
  • acl: [User]
  • # If state==FAILED, resulting from CreateImageFromMachine failure, then there may
  • # be an error object of the form {"code": "", "message":
  • # ""}
  • error: ImageError
  • }