image_schema.json

{
  "properties": {
    "schema": {
      "description": "(READ-ONLY)",
      "type": "string"
    },
    "self": {
      "description": "(READ-ONLY)",
      "type": "string"
    },
    "direct_url": {
      "description": "URL to access the image file kept in external store (READ-ONLY)",
      "type": "string"
    },
    "architecture": {
      "is_base": false,
      "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
      "type": "string"
    },
    "protected": {
      "description": "If true, image will not be deletable.",
      "type": "boolean"
    },
    "os_version": {
      "is_base": false,
      "description": "Operating system version as specified by the distributor",
      "type": "string"
    },
    "disk_format": {
      "description": "Format of the disk",
      "type": [
        "null",
        "string"
      ],
      "enum": [
        null,
        "ami",
        "ari",
        "aki",
        "vhd",
        "vmdk",
        "raw",
        "qcow2",
        "vdi",
        "iso"
      ]
    },
    "created_at": {
      "description": "Date and time of image registration (READ-ONLY)",
      "type": "string"
    },
    "checksum": {
      "maxLength": 32,
      "description": "md5 hash of image contents. (READ-ONLY)",
      "type": [
        "null",
        "string"
      ]
    },
    "name": {
      "maxLength": 255,
      "description": "Descriptive name for the image",
      "type": [
        "null",
        "string"
      ]
    },
    "os_distro": {
      "is_base": false,
      "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
      "type": "string"
    },
    "visibility": {
      "description": "Scope of image accessibility",
      "type": "string",
      "enum": [
        "public",
        "private"
      ]
    },
    "locations": {
      "description": "A set of URLs to access the image file kept in external store",
      "type": "array",
      "items": {
        "properties": {
          "metadata": {
            "type": "object"
          },
          "url": {
            "maxLength": 255,
            "type": "string"
          }
        },
        "type": "object",
        "required": [
          "url",
          "metadata"
        ]
      }
    },
    "ramdisk_id": {
      "is_base": false,
      "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.",
      "type": [
        "null",
        "string"
      ],
      "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$"
    },
    "min_ram": {
      "description": "Amount of ram (in MB) required to boot image.",
      "type": "integer"
    },
    "container_format": {
      "description": "Format of the container",
      "type": [
        "null",
        "string"
      ],
      "enum": [
        null,
        "ami",
        "ari",
        "aki",
        "bare",
        "ovf",
        "ova"
      ]
    },
    "kernel_id": {
      "is_base": false,
      "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.",
      "type": [
        "null",
        "string"
      ],
      "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$"
    },
    "tags": {
      "description": "List of strings related to the image",
      "type": "array",
      "items": {
        "maxLength": 255,
        "type": "string"
      }
    },
    "status": {
      "description": "Status of the image (READ-ONLY)",
      "type": "string",
      "enum": [
        "queued",
        "saving",
        "active",
        "killed",
        "deleted",
        "pending_delete"
      ]
    },
    "updated_at": {
      "description": "Date and time of the last image modification (READ-ONLY)",
      "type": "string"
    },
    "owner": {
      "maxLength": 255,
      "description": "Owner of the image",
      "type": [
        "null",
        "string"
      ]
    },
    "file": {
      "description": "(READ-ONLY)",
      "type": "string"
    },
    "min_disk": {
      "description": "Amount of disk space (in GB) required to boot image.",
      "type": "integer"
    },
    "virtual_size": {
      "description": "Virtual size of image in bytes (READ-ONLY)",
      "type": [
        "null",
        "integer"
      ]
    },
    "id": {
      "description": "An identifier for the image",
      "type": "string",
      "pattern": "^([0-9a-fA-F]){24}$"
    },
    "size": {
      "description": "Size of image file in bytes (READ-ONLY)",
      "type": [
        "null",
        "integer"
      ]
    },
    "instance_uuid": {
      "is_base": false,
      "description": "ID of instance used to create this image.",
      "type": "string"
    }
  },
  "links": [
    {
      "rel": "self",
      "href": "{self}"
    },
    {
      "rel": "enclosure",
      "href": "{file}"
    },
    {
      "rel": "describedby",
      "href": "{schema}"
    }
  ],
  "name": "image",
  "additionalProperties": {
    "type": "string"
  }
}