# images

Manage OS images.
Set management node URL:

# DELETE /images/{image}

Delete a downloaded image from disk

# Parameters

  • imagestringpath-

# Endpoint

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

# GET /images/{image}/{file}

# Parameters

  • imagestringpath-
  • filestringpath-

# 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

  • lateststringoptional-
  • defaultstringoptional-
  • imagesarrayoptional-
    • idstringoptional-
    • descriptionstringoptional-
    • timestampintegeroptional-
    • flagsarrayoptional-
    • downloadedbooleanoptional-
    • downloadingbooleanoptional-
    • progressintegeroptional-
    • downloadErrorstringoptional-
    • fileSizeintegeroptional-

# Example response

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

# POST /images/refresh

# Parameters

  • No parameters...

# Endpoint

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

# Response 200

  • lateststringoptional-
  • defaultstringoptional-
  • imagesarrayoptional-
    • idstringoptional-
    • descriptionstringoptional-
    • timestampintegeroptional-
    • flagsarrayoptional-
    • downloadedbooleanoptional-
    • downloadingbooleanoptional-
    • progressintegeroptional-
    • downloadErrorstringoptional-
    • fileSizeintegeroptional-

# Example response

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

# POST /images/default

# Parameters

  • bodyobjectoptional-
    • overrideServersbooleanoptional-
    • defaultstringoptional-

# Endpoint

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

# Example body

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

# POST /images/{image}/startDownload

# Parameters

  • imagestringpath-

# Endpoint

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

# POST /servers/{id}/terminal/connect

Connect to the server via SSH.

# Parameters

  • idintegerpath-

# Endpoint

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

# Response 200

  • pathstringoptionalConnect here.
  • tlsPortintegeroptionalConnect to this port for TLS.
  • plaintextPortintegeroptionalConnect to this port for an unencrypted connection.
  • authTokenstringoptionalPass as Authorization header.
  • validUntilintegeroptionalURL is valid until this time, existing connections stay connected afterwards.
  • iscsibooleanoptionalWhether this is a connection to an iSCSI gateway.

# Example response

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