Get all virtual machines for the account

GET

https://api.americancloud.com/api/v1/compute/vms

GET

/api/v1/compute/vms

curl https://api.americancloud.com/api/v1/compute/vms \
     -H "X-API-Client-ID: <apiKey>"

{
  "total": 42,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "my-vm",
      "status": "STARTED",
      "region": "sjc0",
      "cpu": 4,
      "memoryMb": 8192,
      "rootDiskGb": 50,
      "image": "ubuntu-22.04",
      "ipAddress": "192.168.1.10",
      "networkName": "production-network",
      "networkId": "123e4567-e89b-12d3-a456-426614174000",
      "rootVolumeId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-05-29T12:34:56Z",
      "vmPackage": "standard-2-4",
      "tags": [
        "production",
        "web-tier"
      ],
      "subscriptionPeriod": "monthly",
      "imageDisplayName": "Ubuntu 22.04 LTS",
      "versionStartedAt": "2026-05-29T12:34:56Z",
      "marketplaceApp": {
        "label": "coolify",
        "name": "Coolify",
        "docsUrl": "https://coolify.io/docs"
      }
    }
  ]
}

Authentication

X-API-Client-IDstring

API Client ID

X-API-Client-Secretstring

API Client Secret

Query parameters

pageintegerOptional>=1

Page number, 1-indexed. Defaults to 1 when omitted.

pageSizeintegerOptional1-500

Items per page. Defaults to 100 when omitted; server cap 500.

Response

totaldouble

Total number of items matching the request, across all pages. Use this together with pageSize to compute how many pages exist.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error