images

Manage OS images.

GET /images/{image}/{file}

Parameters

image
string
path
-
file
string
path
-

Endpoint

curl -X GET http://mgmt-node:8080/api/images/{image}/{file}
                

GET /images

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/images
                

Response 200

latest
string
optional
-
default
string
optional
-
images
array
optional
-

Example response

{
  "latest": "string",
  "default": "string",
  "images": [
    {
      "id": "string",
      "description": "string",
      "timestamp": 0,
      "flags": [
        "string"
      ],
      "downloaded": true,
      "downloading": true,
      "downloadError": "string",
      "fileSize": 0,
      "progress": 0
    }
  ]
}
                  

DELETE /images/{image}

Parameters

image
string
path
-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/images/{image}
                

POST /images/refresh

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/images/refresh
                

Response 200

latest
string
optional
-
default
string
optional
-
images
array
optional
-

Example response

{
  "latest": "string",
  "default": "string",
  "images": [
    {
      "id": "string",
      "description": "string",
      "timestamp": 0,
      "flags": [
        "string"
      ],
      "downloaded": true,
      "downloading": true,
      "downloadError": "string",
      "fileSize": 0,
      "progress": 0
    }
  ]
}
                  

POST /images/default

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/images/default
                

Example body

{
  "overrideServers": true,
  "default": "string"
}
                

POST /images/{image}/startDownload

Parameters

image
string
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/images/{image}/startDownload
                

POST /servers/{id}/terminal/connect

Parameters

id
integer
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/servers/{id}/terminal/connect
                

Response 200

path
string
optional
Connect here.
tlsPort
integer
optional
Connect to this port for TLS.
plaintextPort
integer
optional
Connect to this port for an unencrypted connection.
authToken
string
optional
Pass as Authorization header.
validUntil
integer
optional
URL is valid until this time, existing connections stay connected afterwards.
iscsi
boolean
optional
Whether this is a connection to an iSCSI gateway.

Example response

{
  "path": "string",
  "tlsPort": 0,
  "plaintextPort": 0,
  "authToken": "string",
  "validUntil": 0,
  "iscsi": true
}