List Virtual Machine Instances

Retrieve a comprehensive inventory of your virtual machine instances, including detailed specifications such as hardware configurations, system identifiers, operating systems, and operational status.

HTTP Request

GET {API_URL}virtual-machines

Query Parameters

Parameter	Requirement	Type	Description
limit	Optional	int	Maximum number of records to return
offset	Optional	int	Number of records to skip for pagination
sortField	Optional	string	Field identifier for result ordering
sortOrder	Optional	string	Sort direction: desc (descending) or asc (ascending)
filters	Optional	string	JSON-encoded filter criteria. Format: [{"key":"name","op":"contains","val":"hub"}]

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

total int

Aggregate count of available records.

data object

Collection of instance objects containing detailed specifications.

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

Implementation Example

Request

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

Response

{
    "status": true,
    "message": "Instance inventory retrieved successfully",
    "total": 1,
    "data": [
        {
            "id": "676cf147e39574b1e3149831",
            "name": "VM-dhSqfrqh",
            "status": "running",
            "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"
            }
        }
    ]
}