Retrieve Virtual Machine Instance Details

Access comprehensive information about a specific virtual machine instance by providing its unique identifier. The response includes detailed configuration specifications and current operational status.

HTTP Request

GET {API_URL}virtual-machines/{id}

Path Parameters

Parameter	Requirement	Type	Description
id	Required	string	Target instance's unique identifier

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 information retrieval request.

data object

Comprehensive instance information including configuration specifications, operational parameters, and resource allocation details.

For detailed documentation of instance attributes, please refer to our Instance Object Documentation.

Implementation 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": "Instance details retrieved successfully",
    "data": {
        "id": "676cf147e39574b1e3149831",
        "name": "VM-dhSqfrqh",
        "status": "creating",
        "login": {
            "ssh_key": {
                "name": "sshkey"
            },
            "password": "password",
            "username": "username"
        },
        "fixed_ip": "*.*.*.*",
        "started_time": 1735180651,
        "flavor": {
            "name": "1 x RTX4090",
            "cpu": 16,
            "ram": 32,
            "disk": 250,
            "gpu": "RTX4090",
            "gpu_count": 1
        },
        "image": {
            "name": "Ubuntu-22.04"
        },
        "region": {
            "name": "DALLAS"
        }
    }
}