images

Manage OS images.
get /images
Parameters
pagination string query
Responses
200 successful operation
ImageListReply object 
{
  "data": [
    {
      "id": "string",
      "os": "DEBIAN",
      "flags": [
        "string"
      ],
      "commit": "string",
      "osName": "string",
      "default": true,
      "hasSssd": true,
      "nightly": true,
      "extended": true,
      "fileSize": 0,
      "progress": 0,
      "osVersion": "string",
      "timestamp": 0,
      "deprecated": true,
      "downloaded": true,
      "cephVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "daosVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "description": "string",
      "downloading": true,
      "sambaVersion": "string",
      "downloadError": "string",
      "kernelVersion": "string",
      "osRepoVersion": "string",
      "flagsFormatted": "string",
      "ganeshaVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "cpuArchitecture": "AMD64",
      "cephVersionShort": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0,
  "images": [
    {
      "id": "string",
      "os": "DEBIAN",
      "flags": [
        "string"
      ],
      "commit": "string",
      "osName": "string",
      "default": true,
      "hasSssd": true,
      "nightly": true,
      "extended": true,
      "fileSize": 0,
      "progress": 0,
      "osVersion": "string",
      "timestamp": 0,
      "deprecated": true,
      "downloaded": true,
      "cephVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "daosVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "description": "string",
      "downloading": true,
      "sambaVersion": "string",
      "downloadError": "string",
      "kernelVersion": "string",
      "osRepoVersion": "string",
      "flagsFormatted": "string",
      "ganeshaVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "cpuArchitecture": "AMD64",
      "cephVersionShort": "string"
    }
  ],
  "latestX86": "string",
  "defaultX86": "string",
  "latestArm64": "string",
  "defaultArm64": "string"
}
get /images/archs
Responses
200 successful operation
ArchConfig object 
{
  "arm64": true,
  "x86_64": true
}
put /images/archs
Parameters
body object 
{
  "arm64": true,
  "x86_64": true
}
Responses
default successful operation
delete /images/unused

Delete all unused images from disk. This includes all images that are not the default image and are not used by any server.

Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
post /images/default
Parameters
body object 
{
  "default": "string",
  "overrideServers": true
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
post /images/refresh
Responses
200 successful operation
ImageListReply object 
{
  "data": [
    {
      "id": "string",
      "os": "DEBIAN",
      "flags": [
        "string"
      ],
      "commit": "string",
      "osName": "string",
      "default": true,
      "hasSssd": true,
      "nightly": true,
      "extended": true,
      "fileSize": 0,
      "progress": 0,
      "osVersion": "string",
      "timestamp": 0,
      "deprecated": true,
      "downloaded": true,
      "cephVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "daosVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "description": "string",
      "downloading": true,
      "sambaVersion": "string",
      "downloadError": "string",
      "kernelVersion": "string",
      "osRepoVersion": "string",
      "flagsFormatted": "string",
      "ganeshaVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "cpuArchitecture": "AMD64",
      "cephVersionShort": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0,
  "images": [
    {
      "id": "string",
      "os": "DEBIAN",
      "flags": [
        "string"
      ],
      "commit": "string",
      "osName": "string",
      "default": true,
      "hasSssd": true,
      "nightly": true,
      "extended": true,
      "fileSize": 0,
      "progress": 0,
      "osVersion": "string",
      "timestamp": 0,
      "deprecated": true,
      "downloaded": true,
      "cephVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "daosVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "description": "string",
      "downloading": true,
      "sambaVersion": "string",
      "downloadError": "string",
      "kernelVersion": "string",
      "osRepoVersion": "string",
      "flagsFormatted": "string",
      "ganeshaVersion": {
        "major": 0,
        "minor": 0,
        "revision": 0
      },
      "cpuArchitecture": "AMD64",
      "cephVersionShort": "string"
    }
  ],
  "latestX86": "string",
  "defaultX86": "string",
  "latestArm64": "string",
  "defaultArm64": "string"
}
delete /images/{image}

Delete a downloaded image from disk

Parameters
image string path Required
Responses
default successful operation
get /images/{image}/{file}
Parameters
image string path Required
file string path Required
Responses
default successful operation
get /images/packages/{image}
Parameters
image string path Required
Responses
200 successful operation
ImagePackage array
ImagePackage object 
[
  {
    "name": "string",
    "release": "string",
    "version": "string"
  }
]
post /images/{image}/startDownload
Parameters
image string path Required
Responses
default successful operation
post /servers/{id}/terminal/connect

Connect to the server via SSH.

Parameters
id integer path Required
Responses
200 successful operation
TerminalConnection object 
{
  "path": "string",
  "iscsi": true,
  "tlsPort": 0,
  "authToken": "string",
  "validUntil": 0,
  "plaintextPort": 0
}