Retrieve VM Instance Details

Retrieves the details of an existing virtual machine. Supply the virtual machine ID in the path, and API will return the corresponding Virtual Machine object.

HTTP Request

GET {API_URL}virtual-machines/{id}

Path parameters

Parameters	Requirements	Type	Description
id	Required	string	The unique identifier of the virtual machine for which to retrieve details.

Reponse Attributes

status boolean

Indicates the result of the request to retrieve a list of VM detail. true signifies success, while false indicates an error.

message string

A description of the status of the request.

data object

The instance object contains details including configuration and specification details about the virtual machine.

For descriptions of the fields within the instance object returned in response to your request, please refer to the documentation here.

Example

Request

curl -X GET '{API_URL}virtual-machines/{id}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json'

Response

{
    "status": true,
    "message": "Getting virtual machine successful",
    "data": {
        "id": "66bd5a1299f01e419f5ad5bc",
        "name": "VM-dhSqf5qh",
        "status": "creating",
        "login": {
            "_id": "66bd5a1299f01e419f5ad5bd",
            "ssh_key": {
                "id": "66bd5a0799f01e419f5ad5b6",
                "name": "sshkey"
            },
            "password": "password",
            "username": "username"
        },
        "fixed_ip": "*.*.*.*",
        "started_time": 1723685400,
        "flavor": {
            "name": "1 x RTX4090",
            "cpu": 16,
            "ram": 32,
            "disk": 250,
            "gpu": "RTX4090",
            "gpu_count": 1
        },
        "image": {
            "name": "Ubuntu-22.04"
        },
        "region": {
            "name": "DALLAS"
        }
    }
}