CustomImageDetail

Full detail of a custom image including datacenter deployments

  • active
    Type: boolean
    required

    Whether the image is active and available for use

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • deployments
    Type: array object[]
    required

    Datacenters this image has been deployed to

    • createdAt
      Type: stringFormat: date-time
      required

      When this deployment was created

    • datacenterId
      Type: stringFormat: uuid
      required

      Datacenter ID

    • datacenterName
      Type: string
      required

      Datacenter display name

    • id
      Type: stringFormat: uuid
      required

      Deployment record ID

    • continentName
      Type: string nullable

      Continent / business region name

    • countryName
      Type: string

      Country name

    • datacenterCode
      Type: string nullable

      Short datacenter code (e.g. CHI-1)

    • regionName
      Type: string

      Region name

  • id
    Type: stringFormat: uuid
    required

    Custom image ID

  • name
    Type: string
    required

    Display name of the image

  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • bootMode
    Type: string nullable

    Boot mode

  • bootType
    Type: string nullable

    Boot type (e.g. UEFI, BIOS)

  • config
    Type: object

    Image configuration object (e.g. { type: "cloud-init" } or { type: "none" })

    • propertyName
      Type: anything
  • description
    Type: string nullable

    Optional description

  • imageType
    Type: stringenum

    Image type classification

    values
    • template
    • iso
  • networkHotplug
    Type: boolean

    Whether VMs created from this image support network hotplug

  • osFamily
    Type: string

    Operating system family (e.g. linux, windows)

  • userdata
    Type: string nullable

    Cloud-init userdata script

  • username
    Type: string nullable

    Default login username