CustomImageDetail

Full detail of a custom image including data center 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

  • deployable
    Type: boolean
    required

    True when this image can be deployed to additional data centers via self-service: the caller owns it, it is staged, AND it has an uploaded source file. False for images provisioned directly (no uploaded source) — they remain usable for VM creation at their existing data centers but cannot be deployed to new ones. Gate the deploy action on this flag; gating on isOwner alone is insufficient because owners can have non-deployable provisioned images. POST .../deployments returns 422 if attempted on a non-deployable image.

  • deployments
    Type:
    required

    Data centers this image has been deployed to. Items use the same shape as the standalone GET .../deployments endpoint — includes per-deployment state, stateChangedAt, and failureReason.

    Properties: 11
  • id
    Type: stringFormat: uuid
    required

    Custom image ID

  • isOwner
    Type: boolean
    required

    True when your tenant owns this image (uploaded it). False when the image is shared with your tenant by another owner or provided by the platform. Owners get full control; non-owners get read-only access — the backend rejects non-owner deploys, deletes, and firmware changes with 403. Gate destructive UI affordances on this flag.

  • name
    Type: string
    required

    Display name of the image

  • state
    Type: stringenum
    required

    Lifecycle state. pending = upload in progress; staged = uploaded and ready for use; failed = upload did not complete; deleting = deletion in progress (visible until removal completes). Setting active=true via update is rejected with 400 unless state is staged.

    values
    pendingstagedfaileddeleting
  • uefi
    Type: boolean
    required

    True = UEFI with secure boot; false = legacy/omit firmware params. Drives the boot-mode toggle on the image. Settable at upload and flippable via PUT (pure metadata update, applied to future VM creates).

  • 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

  • config
    Type: object

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

    Properties: 1
  • description
    Type: stringnullable

    Optional description

  • imageType
    Type: "template" or "iso"enum

    Image type classification

  • networkHotplug
    Type: boolean

    Whether VMs created from this image support network hotplug

  • osFamily
    Type: string

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

  • userdata
    Type: stringnullable

    Cloud-init userdata script

  • username
    Type: stringnullable

    Default login username

Previous
CustomImageListItem
Next
NetworksListModel