---
title: "Get a VM"
method: GET
path: "/agent/compute/vms/{id}"
tags: ["Compute"]
---

# Get a VM

`GET /agent/compute/vms/{id}`

## Request

- Base URL: `https://edge.network`
- URL: `https://edge.network/agent/compute/vms/{id}`
- Auth: HTTP bearer

VM details, live metrics, attached SSH keys, and a ready-to-use ssh command. Poll until status is "running".

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `vm` Vm, required
    - `id` string, required
    - `name` string, required
    - `status` string, required: Lifecycle status. Poll until "running" before attempting SSH.
    - `size` 'nano' | 'small' | 'medium' | 'large' | 'xlarge'
    - `vcpu` number
    - `ram` number: RAM in GB.
    - `disk` number: Disk in GB.
    - `region` string
    - `os` string
    - `network` object
      - `publicIp` string, nullable
  - `tell_user` string: Human-readable summary of what happened, for the agent to relay to its operator.

## Other responses

- `400`: Validation error — the response body explains what to fix.
- `401`: Missing or invalid agent access code. The body includes self-signup pointers.
- `429`: Rate limited. Honour Retry-After and the RateLimit-* headers before retrying.

---

[API](https://skmtc.dev/edge/apis/edge-network-agent-api.md) · [All operations](https://skmtc.dev/edge/apis/edge-network-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/edge/apis/edge-network-agent-api/revisions/49b5f2adf020?raw)