GET /v1/catalogue/images
The self-service image catalogue: every entry for operators, the offered ones for tenant users.
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | array of CatalogueImageView |
API: plans
Operations of the plans tag of the native REST API.
VM plans and the self-service image catalogue (operator-managed)
GET
PUT /v1/catalogue/images/{id}
Sets the catalogue flag and metadata of a template (Kyvernon.Catalogue.Manage).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | The template VM (vm-N) |
Request body
application/json: CatalogueImageView
| Name | Type | Required | Description |
|---|---|---|---|
catalogue | boolean | Offered to tenants. | |
cloudInit | boolean | Personalised through cloud-init. | |
defaultUser | string | Default user. | |
displayName | string | Name shown to tenants. | |
minDiskGib | integer (int64) | Smallest disk (GiB). | |
noCredentials | boolean | Takes no credentials (no password or SSH keys; e.g. EuroOS). | |
osFamily | string | linux, windows, euroos, bsd or other. | |
osVersion | string | OS version. | |
rescue | boolean | A rescue image. | |
templateId | string | The template (vm-N; ignored in requests, the path names it). | |
templateName | string | The template's name. |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | CatalogueImageView |
| 400 | Invalid argument; the error body names the field | ErrorBody |
| 412 | Failed precondition; the error body says which | ErrorBody |
DELETE /v1/catalogue/images/{id}
Removes a template from the catalogue.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the catalogue image (a template virtual machine) |
Responses
| Status | Description | Schema |
|---|---|---|
| 204 | Done; no body | |
| 404 | Not found (or not visible to the caller) | ErrorBody |
GET /v1/plans
VM plans: all for operators, the orderable ones for tenant users.
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | array of PlanView |
POST /v1/plans
Creates a plan (Kyvernon.Plan.Manage).
Request body
application/json: PlanView
| Name | Type | Required | Description |
|---|---|---|---|
allowedImages | array of string | Images that may be used (empty: every catalogue image). | |
bandwidthMbit | integer (int32) or null | Bandwidth cap (Mbit/s). | |
description | string | Description. | |
diskGib | integer (int64) | yes | Disk (GiB). |
diskType | string | thin or thick. | |
id | string | vmplan-N (ignored in requests). | |
ipv6 | boolean | An IPv6 /64. | |
memoryMib | integer (int64) | yes | Memory (MiB). |
name | string | yes | Unique name. |
orderable | boolean | Orderable by tenants. | |
publicIpv4 | integer (int32) | Public IPv4 addresses included. | |
trafficAction | string | notify or throttle at 100 % of the monthly traffic. | |
trafficGibMonth | integer (int64) | Traffic per month (GiB, 0 = unmetered). | |
vcpus | integer (int32) | yes | vCPUs. |
Responses
GET /v1/plans/{id}
One plan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the plan (vmplan-N) |
Responses
PUT /v1/plans/{id}
Replaces a plan (Kyvernon.Plan.Manage); servers keep their size until resized.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the plan (vmplan-N) |
Request body
application/json: PlanView
| Name | Type | Required | Description |
|---|---|---|---|
allowedImages | array of string | Images that may be used (empty: every catalogue image). | |
bandwidthMbit | integer (int32) or null | Bandwidth cap (Mbit/s). | |
description | string | Description. | |
diskGib | integer (int64) | yes | Disk (GiB). |
diskType | string | thin or thick. | |
id | string | vmplan-N (ignored in requests). | |
ipv6 | boolean | An IPv6 /64. | |
memoryMib | integer (int64) | yes | Memory (MiB). |
name | string | yes | Unique name. |
orderable | boolean | Orderable by tenants. | |
publicIpv4 | integer (int32) | Public IPv4 addresses included. | |
trafficAction | string | notify or throttle at 100 % of the monthly traffic. | |
trafficGibMonth | integer (int64) | Traffic per month (GiB, 0 = unmetered). | |
vcpus | integer (int32) | yes | vCPUs. |
Responses
DELETE /v1/plans/{id}
Deletes a plan that no server uses (error.plan.in_use).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the plan (vmplan-N) |
Responses
| Status | Description | Schema |
|---|---|---|
| 204 | Done; no body | |
| 412 | Failed precondition; the error body says which | ErrorBody |
Version 0.1.