List Images

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

HTTP Request

GET {API_URL}/images

Query string parameters

Parameters	Requirements	Type	Description
region_id	Optional	string	Include 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}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": "Windows-11",
            "type": "Windows",
            "region_name": "DALLAS",
            "id": "66b2d63c9e793247704c59ff"
        },
        {
            "name": "Ubuntu-22.04",
            "type": "Ubuntu",
            "region_name": "DALLAS",
            "id": "66b2d63c9e793247704c5a01"
        }
    ]
}