Images

Manage OS images used for iPXE network booting.

Available Images

GET /images/available

List all OS images available in the NodeFoundry registry. Use this to discover images before downloading them.

Response

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Ubuntu Server 24.04",
    "distro": "ubuntu",
    "version": "24.04",
    "arch": "amd64"
  }
]

Downloaded Images

GET /images/downloaded

List images that have been downloaded to the master node. Includes which image is set as the default boot image.

Response

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Ubuntu Server 24.04",
    "distro": "ubuntu",
    "version": "24.04",
    "arch": "amd64",
    "default": true
  }
]

Download Image

GET /images/{imageId}/download

Start an asynchronous download of an image from the registry. Supports short IDs for convenience. Monitor download progress via the SSE events endpoint.

Response

{ "status": "downloading" }

Set Default Image

POST /images/{imageId}/default

Set a downloaded image as the default boot image for iPXE provisioning. The image must already be downloaded.

Delete Image

DELETE /images/{imageId}

Delete a downloaded image from the master node. Cannot delete the image currently set as default.