Skip to main content
GET
/
vm
/
{vm_id}
/
ssh_key
cURL
curl --request GET \
  --url https://api.example.com/vm/{vm_id}/ssh_key \
  --header 'Authorization: Bearer <token>'
{
  "ssh_port": 1,
  "ssh_private_key": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vm_id
string<uuid>
required

Node ID

Response

List all VMs on node

Response body for GET /api/vm/{vm_id}/ssh_key

ssh_port
integer<int32>
required

The SSH port that will be DNAT'd to the VM's netns (and, in turn, to its TAP device)

Required range: x >= 0
ssh_private_key
string
required

Private SSH key in stringified OpenSSH format