> For the complete documentation index, see [llms.txt](https://docs.yottalabs.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yottalabs.ai/api-and-sdk/api-guides/virtual-machines.md).

# Virtual Machines

#### Create VM

```bash
POST /v2/vms
```

**Request Body:**

```json
{
  "vmTypeId": 1,
  "region": "us-east-1",
  "name": "my-vm",
  "isSpot": 0,
  "volumeMountPaths": {
    "123": "/mnt/data",
    "456": "/mnt/models"
  }
}
```

| FIELD            | TYPE    | REQUIRED | DESCRIPTION                      |
| ---------------- | ------- | -------- | -------------------------------- |
| vmTypeId         | integer | Yes      | VM type ID                       |
| region           | string  | Yes      | Region code (e.g., "us-east-1")  |
| name             | string  | Yes      | VM display name                  |
| isSpot           | integer | No       | 0=on-demand, 1=spot (default: 0) |
| volumeMountPaths | map     | No       | Volume ID to mount path mapping  |

**Response:**

```json
{
  "message": "success",
  "code": 10000,
  "data": {
    "id": 456,
    "name": "my-vm",
    "status": "running",
    "gpuDisplayName": "NVIDIA RTX A4000",
    "ipAddress": "192.168.1.100",
    "cpuCores": 8,
    "memoryInGb": "32",
    "gpuCount": 1,
    "gpuMemoryInGb": "16",
    "region": "us-east-1",
    "storageInGb": "100",
    "sshTemplate": "ssh root@192.168.1.100",
    "createdAt": "2024-01-15T10:30:00Z",
    "isSpot": 0
  }
}
```

#### Get VM by ID

```bash
GET /v2/vms/{id}
```

**Response:** Same as create

#### List VMs (Paginated)

```bash
GET /v2/vms
```

**Query Parameters:**

| PARAMETER | TYPE   | DEFAULT | DESCRIPTION                        |
| --------- | ------ | ------- | ---------------------------------- |
| page      | long   | 1       | Page number (1-based)              |
| size      | long   | 10      | Page size                          |
| status    | string | -       | Filter by status (e.g., "running") |

**Response:**

```json
{
  "message": "success",
  "code": 10000,
  "data": {
    "items": [ ... ],
    "page": 1,
    "size": 10,
    "total": 42,
    "pages": 5
  }
}
```

#### Update VM (Rename)

```bash
PATCH /v2/vms/{id}
```

**Request Body:**

```json
{
  "name": "updated-vm-name"
}
```

#### Terminate VM

```bash
DELETE /v2/vms/{id}
```

**Response:**

```json
{
  "message": "success",
  "code": 10000,
  "data": true
}
```

#### Get VM Types

```bash
GET /v2/vms/types
```

Returns all available GPU types and their availability by region. Required for creating VMs - the `vmTypeId` in create request comes from this list.

**Response:**

```json
{
  "message": "success",
  "code": 10000,
  "data": [
    {
      "gpuType": "NVIDIA_RTX_4090_24G",
      "regions": [
        {
          "region": "us-east-1",
          "regionName": "US East",
          "available": true,
          "vmTypeId": 1
        }
      ]
    },
    {
      "gpuType": "NVIDIA_RTX_A6000_48G",
      "regions": [
        {
          "region": "us-west-1",
          "regionName": "US West",
          "available": true,
          "vmTypeId": 2
        }
      ]
    }
  ]
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.yottalabs.ai/api-and-sdk/api-guides/virtual-machines.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.