images

Manage OS images.

get /images/{image}/{file}

Arguments
  • imagerequiredstring

    -

  • filerequiredstring

    -

Definition
get /images/{image}/{file}

get /images

Arguments
  • No arguments...

Definition
get /images
Attributes
  • lateststring

    -

  • defaultstring

    -

  • imagesarray

    -

    • idstring

      -

    • descriptionstring

      -

    • timestampinteger

      -

    • flagsarray

      -

    • downloadedboolean

      -

    • downloadingboolean

      -

    • fileSizeinteger

      -

    • progressinteger

      -

    • downloadErrorstring

      -

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

delete /images/{image}

Delete a downloaded image from disk

Arguments
  • imagerequiredstring

    -

Definition
delete /images/{image}

post /images/refresh

Arguments
  • No arguments...

Definition
post /images/refresh
Attributes
  • lateststring

    -

  • defaultstring

    -

  • imagesarray

    -

    • idstring

      -

    • descriptionstring

      -

    • timestampinteger

      -

    • flagsarray

      -

    • downloadedboolean

      -

    • downloadingboolean

      -

    • fileSizeinteger

      -

    • progressinteger

      -

    • downloadErrorstring

      -

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

post /images/default

Arguments
  • bodyoptional

    -

Definition
post /images/default

post /images/{image}/startDownload

Arguments
  • imagerequiredstring

    -

Definition
post /images/{image}/startDownload

post /servers/{id}/terminal/connect

Connect to the server via SSH.

Arguments
  • idrequiredinteger

    -

Definition
post /servers/{id}/terminal/connect
Attributes
  • pathstring

    Connect here.

  • tlsPortinteger

    Connect to this port for TLS.

  • plaintextPortinteger

    Connect to this port for an unencrypted connection.

  • authTokenstring

    Pass as Authorization header.

  • validUntilinteger

    URL is valid until this time, existing connections stay connected afterwards.

  • iscsiboolean

    Whether this is a connection to an iSCSI gateway.

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