Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeVMs

SSH keys attached to a VM + the org's keys

Lists every SSH key of the VM's organization with its name and fingerprint, each flagged attached when it is in this VM's allowed set of SSH keys.

Required permission

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl vms ssh-key get <id>
GET
/v1/vms/{id}/ssh-keys

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

id*string

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/vms/string/ssh-keys'
Example Response
[  {    "id": "string",    "name": "string",    "fingerprint": "string",    "attached": true,    "crossOrg": true,    "orgName": "string"  }]

Resize a stopped VM's disk POST

Beta: a stopped VM's new disk size is validated and recorded, but the disk is not yet resized on the node. The disk can grow, never shrink. A pod's volume cannot be resized.

Attach an org SSH key to a VM POST

Adds one of the org's SSH keys to the VM's allowed set, so the gateway accepts that key for SSH into the guest. Attaching a key already attached answers 204. The key must be a live key of the VM's organization, and a terminated VM answers 400.