Image Data

Uploads and downloads raw image data

Download image data

get

Downloads binary image data

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

image_idstring · uuidRequired

The UUID of the image

Header parameters

RangestringOptional

The range of image data requested

Responses

200

Image data downloaded successfully

application/octet-stream

Responsestring · binary

204

No image data exists

206

Partial content returned

application/octet-stream

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

416

Range Not Satisfiable

get/images/{image_id}/file

HTTPcURLJavaScriptPython

GET /glance/v2/images/{image_id}/file HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

binary

Upload image data

put

Uploads binary image data

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

image_idstring · uuidRequired

The UUID of the image

Header parameters

X-Image-Meta-StorestringOptional

A store identifier to upload image data

Body

application/octet-stream

string · binaryOptional

Responses

204

Image data uploaded successfully

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

410

Gone

application/json

413

Payload Too Large

application/json

415

Unsupported Media Type

application/json

503

Service Unavailable

application/json

put/images/{image_id}/file

HTTPcURLJavaScriptPython

PUT /glance/v2/images/{image_id}/file HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"

No content

Stage image data

put

Places the binary image data in a staging area for interoperable image import

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

image_idstring · uuidRequired

The UUID of the image

Body

application/octet-stream

string · binaryOptional

Responses

204

Image data staged successfully

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

409

Conflict

application/json

410

Gone

application/json

413

Payload Too Large

application/json

415

Unsupported Media Type

application/json

503

Service Unavailable

application/json

put/images/{image_id}/stage

HTTPcURLJavaScriptPython

PUT /glance/v2/images/{image_id}/stage HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"

No content

Import image

post

Signals the Image Service to complete the image import workflow

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters

image_idstring · uuidRequired

The UUID of the image

Header parameters

X-Image-Meta-StorestringOptional

A store identifier to import image data

Body

application/json

storesstring[]Optional

List of store identifiers to import to

all_storesbooleanOptional

Import to all available stores

all_stores_must_succeedbooleanOptional

Whether all stores must succeed for the operation to succeed

Responses

202

Image import initiated successfully

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

409

Conflict

application/json

410

Gone

application/json

413

Payload Too Large

application/json

415

Unsupported Media Type

application/json

503

Service Unavailable

application/json

post/images/{image_id}/import

HTTPcURLJavaScriptPython

POST /glance/v2/images/{image_id}/import HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "method": {
    "name": "glance-direct",
    "uri": "https://example.com",
    "glance_image_id": "123e4567-e89b-12d3-a456-426614174000",
    "glance_region": "text",
    "glance_service_interface": "text"
  },
  "stores": [
    "text"
  ],
  "all_stores": true,
  "all_stores_must_succeed": true
}

No content