List OS images

GET

/os-images/

Returns available OS images grouped by type with region availability. Supports discovery mode to list all images across regions, or filtered mode by specific region and GPU type with validation.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Query Params

Responses

🟢200

application/json

OS images retrieved successfully

Body

🟠400

🟠401

🔴500

🔴502

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://barrack.ai/api/os-images/?gpu_type&region' \
--header 'X-API-Key: <api-key>'

Response Example

200 - Discovery Mode - All Regions

{
    "success": true,
    "images": [
        {
            "id": "Server 22.04 LTS",
            "name": "Ubuntu Server 22.04 LTS (Jammy Jellyfish)",
            "image_type": "Server 22.04 LTS",
            "available_regions": [
                "CANADA-1"
            ],
            "tier": "legacy",
            "note": null
        },
        {
            "id": "ubuntu-24.04-cuda-12.8-open-docker",
            "name": "Ubuntu 24.04 + CUDA 12.8 Open + Docker (Ubuntu 24.04, CUDA 12.8 Open, Docker)",
            "image_type": "ubuntu-24.04-cuda-12.8-open-docker",
            "available_regions": [
                "FINLAND-1",
                "FINLAND-2",
                "FINLAND-3"
            ],
            "tier": "advanced",
            "note": null
        },
        {
            "id": "jupyter",
            "name": "Jupyter (Ubuntu 24.04, CUDA 12.6, PyTorch 2.6)",
            "image_type": "jupyter",
            "available_regions": [
                "FINLAND-1",
                "FINLAND-2",
                "FINLAND-3"
            ],
            "tier": "advanced",
            "note": "Not compatible with B200-180GB GPU"
        }
    ],
    "metadata": {
        "total_images": 37,
        "tier": "mixed",
        "authenticated": true
    }
}

Delete custom image

Create image from snapshot