API

Appearance

List Bare Metal Images ​

Returns a list of all available operating system (OS) images, providing details about each image's corresponding bare metal instance operating system.

HTTP Request ​

GET {API_URL}/bare-metal/images

Query string parameters ​

ParametersRequirementsTypeDescription
region_idOptionalstringInclude a region_id in the query string of the request to return only the images available in the specified region_id

Reponse Attributes ​

status boolean ​

Indicates the success or failure of the retrieval of OS images. true signifies success, while false indicates an error.

message string ​

A message confirming the successful retrieval of images.

data array ​

An array containing information about operating system images, and the region where they are available.

Each system image specifies the following properties:

  • name string: Name of the operating system image.
  • id string: Unique identifier for the operating system image.
  • type string: Operating system type.
  • description string: Description of the region.
  • region_name string: Name of the region associated with the operating system image.
  • region_id string: Unique identifier for the region.

Example ​

Request ​

curl -X GET '{API_URL}/bare-metal/images' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json'

Response ​

{
    "status": true,
    "message": "Getting images successful",
    "data": [
        {
            "name": "Ubuntu Server 22.04 LTS R535 CUDA 12.2",
            "type": "Ubuntu",
            "region_name": "SINGAPORE-1",
            "region_id": "65d4586b07f237cca5eeb5b5",
            "id": "6331d0eb805fd15079b6b183"
        },
        {
            "name": "Ubuntu Server 22.04 LTS (Jammy Jellyfish)",
            "type": "Ubuntu",
            "region_name": "SINGAPORE-1",
            "region_id": "65d4586b07f237cca5eeb5b5",
            "id": "6331d0eb805fd15079b6b184"
        }
    ]
}