List Virtual Machine Images

Retrieve a comprehensive catalog of available operating system images for virtual machine deployment within the Rich platform ecosystem.

HTTP Request

GET {API_URL}/images

Query Parameters

Parameter	Requirement	Type	Description
region_id	Optional	string	Filter images by specific regional availability

Response Structure

status boolean

Operation result indicator. Returns true for successful execution, false when encountering an error.

message string

Descriptive response indicating the outcome of the image catalog retrieval.

data array

Collection of operating system images with regional availability information.

Image attributes include:

• name string: Operating system image designation
• id string: Unique image identifier
• type string: Operating system classification
• description string: Regional deployment specifications
• region_name string: Deployment region designation
• region_id string: Region unique identifier

Implementation 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": "Operating system catalog retrieved successfully",
    "data": [
        {
            "name": "Windows-11",
            "type": "Windows",
            "region_name": "DALLAS",
            "id": "6705f88d906a954599a477db"
        },
        {
            "name": "Ubuntu-22.04",
            "type": "Ubuntu",
            "region_name": "DALLAS",
            "id": "6705f88d906a954599a477dd"
        }
    ]
}