# OpenRelay VMs API

**Canonical:** https://apis.io/apis/openrelay/openrelay-vms-api/  
**Provider:** OpenRelay — https://apis.io/providers/openrelay/  
**Base URL:** https://api.openrelay.inc  
**Documentation:** https://docs.openrelay.inc

OpenRelay VMs API is one of 19 APIs that [OpenRelay](https://apis.io/providers/openrelay/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include VMs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

GPU virtual machines: lifecycle, disks, SSH access, and console links.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/orgs/{orgId}/vms` | List an org's VMs (cursor-paginated) |
| POST | `/v1/orgs/{orgId}/vms/create` | Create a VM |
| GET | `/v1/vms/{id}` | Get a VM by id |
| GET | `/v1/vms/{id}/burn` | Live burn rate, session cost so far, and org runway for a VM |
| GET | `/v1/vms/{id}/detail` | Get a VM with its GPU/node/template info and price |
| POST | `/v1/vms/{id}/reboot` | Reboot a VM |
| POST | `/v1/vms/{id}/resize-disk` | Resize a stopped VM's disk |
| POST | `/v1/vms/{id}/restart` | Restart a VM |
| GET | `/v1/vms/{id}/ssh-keys` | SSH keys attached to a VM + the org's keys |
| POST | `/v1/vms/{id}/ssh-keys` | Attach an org SSH key to a VM |
| POST | `/v1/vms/{id}/stop` | Stop a VM |
| GET | `/v1/vms/{id}/telegram-link` | Get a VM's embedded Telegram link |
| POST | `/v1/vms/{id}/terminate` | Terminate a VM |
| POST | `/v1/vms/{id}/visibility` | Set a VM's endpoint visibility |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openrelay/refs/heads/main/openapi/openrelay-vms-api-openapi.yml
- **Documentation** — https://docs.openrelay.inc
- **APIReference** — https://docs.openrelay.inc/docs/account/overview

## Other OpenRelay APIs (12)

- [OpenRelay Inference API](https://apis.io/apis/openrelay/openrelay-inference-api/)
- [OpenRelay Account API](https://apis.io/apis/openrelay/openrelay-account-api/)
- [OpenRelay API Keys API](https://apis.io/apis/openrelay/openrelay-api-keys-api/)
- [OpenRelay Batches API](https://apis.io/apis/openrelay/openrelay-batches-api/)
- [OpenRelay Billing API](https://apis.io/apis/openrelay/openrelay-billing-api/)
- [OpenRelay Catalog API](https://apis.io/apis/openrelay/openrelay-catalog-api/)
- [OpenRelay Clusters API](https://apis.io/apis/openrelay/openrelay-clusters-api/)
- [OpenRelay Files API](https://apis.io/apis/openrelay/openrelay-files-api/)
- [OpenRelay Internal API](https://apis.io/apis/openrelay/openrelay-internal-api/)
- [OpenRelay Organizations API](https://apis.io/apis/openrelay/openrelay-organizations-api/)
- [OpenRelay Provider API](https://apis.io/apis/openrelay/openrelay-provider-api/)
- [OpenRelay Registry Credentials API](https://apis.io/apis/openrelay/openrelay-registry-credentials-api/)

## Tags

VMs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openrelay/openrelay-vms-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openrelay/.