> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://americancloud.com/docs/api/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://americancloud.com/docs/api/_mcp/server.

# Get all virtual machines for the account

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

Reference: https://americancloud.com/docs/api/api-reference/vms/list-vms

## Authentication

- `X-API-Client-ID` header (required) — API Client ID
- `X-API-Client-Secret` header (required) — API Client Secret

## Request

### Query parameters

- `page` (integer, optional) — Page number, 1-indexed. Defaults to 1 when omitted.
- `pageSize` (integer, optional) — Items per page. Defaults to 100 when omitted; server cap 500.

## Response

### 200

- `total` (double, required) — Total number of items matching the request, across all pages. Use this together with `pageSize` to compute how many pages exist.
- `data` (list of VMResponseDto, required)

## Errors

### 400 Bad Request Error

The request was malformed or failed validation.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 401 Unauthorized Error

Authentication credentials were missing or invalid.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 403 Forbidden Error

The authenticated principal is not permitted to perform this action.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 404 Not Found Error

The requested resource does not exist or is not accessible to the caller.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 500 Internal Server Error

An unexpected error occurred on the server.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

## Types

### VMResponseDto

- `id` (string, required) — Unique identifier for this virtual machine.
- `name` (string, required) — Human-readable name for the VM. Shown in dashboards and CLI output.
- `status` (string, required) — Current lifecycle state of the VM. Observed values include CREATING, STARTING, CREATED, STARTED, STOPPING, STOPPED, and DESTROYED. Treat this as an open set — new states may be introduced over time.
- `region` (string, required) — Region the VM is provisioned in. References a region label from /v1/compute/regions.
- `cpu` (integer, required) — Number of virtual CPUs allocated to the VM.
- `memoryMb` (integer, required) — Memory allocated to the VM, in megabytes.
- `rootDiskGb` (integer, required) — Root disk size, in gigabytes.
- `image` (string, required) — Image label the VM was provisioned from. References /v1/compute/images.
- `ipAddress` (string, required) — Primary IP address assigned to the VM on its network.
- `networkName` (string, required, nullable) — Name of the network or VPC tier this VM is attached to. Null while the VM is still provisioning.
- `networkId` (string, required, nullable) — Identifier of the network or VPC tier this VM is attached to. Null while the VM is still provisioning.
- `rootVolumeId` (string, required, nullable) — Identifier of the VM root volume. Null while the VM is still provisioning.
- `createdAt` (datetime, required) — When the VM was first provisioned.
- `vmPackage` (string, optional) — Package label identifying the CPU/memory/disk preset this VM uses.
- `tags` (list of string, optional) — Tags assigned to this VM for grouping and filtering.
- `subscriptionPeriod` (string, optional) — Billing cadence applied to this VM. Absent for a few moments after the VM is created, while the billing term is still being recorded. Poll until it appears.
- `imageDisplayName` (string, optional) — Friendly name of the source image.
- `versionStartedAt` (datetime, optional) — When the current billing version started (set when the VM is scaled or its disk is resized). Only present if the VM has been modified since creation.
- `marketplaceApp` (MarketplaceAppDto, optional) — Source marketplace app, when the VM was deployed from one. Absent for OS-only deploys.

### ApiErrorDtoMessage

Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.

### ValidationErrorItemDto

- `field` (string, required) — Dotted path to the field that failed validation.
- `message` (string, required) — Human-readable validation message for this field.

### BlockingSnapshotDto

- `id` (string, required) — Snapshot ID.
- `name` (string, required) — Snapshot name.

### MarketplaceAppDto

- `label` (string, required) — Marketplace app slug (URL-safe identifier)
- `name` (string, required) — Marketplace app display name
- `docsUrl` (string, required, nullable) — Link to the app's docs page. May be null if not configured.

## Examples

**Response**

```json
{
  "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"
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.americancloud.com/api/v1/compute/vms"

headers = {"X-API-Client-ID": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.americancloud.com/api/v1/compute/vms';
const options = {method: 'GET', headers: {'X-API-Client-ID': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.americancloud.com/api/v1/compute/vms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Client-ID", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.americancloud.com/api/v1/compute/vms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Client-ID"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.americancloud.com/api/v1/compute/vms")
  .header("X-API-Client-ID", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.americancloud.com/api/v1/compute/vms', [
  'headers' => [
    'X-API-Client-ID' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.americancloud.com/api/v1/compute/vms");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Client-ID", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Client-ID": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.americancloud.com/api/v1/compute/vms")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```