Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferencePricingDashboard
VMs

Attach an org SSH key to a VM

Command line

The orl CLI wraps this endpoint:

orl vms ssh-key attach <id> --ssh-key-id <ssh-key-id>
POST
/v1/vms/{id}/ssh-keys

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/vms/string/ssh-keys" \  -H "Content-Type: application/json" \  -d '{    "sshKeyId": "string"  }'
Empty

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

Previous Page

Detach an org SSH key from a VM DELETE

Removes the key from the VM's allowed set. Detaching a key that is not attached is a no-op (204). The last attached key cannot be detached: an empty set would widen access to every org key (the org-wide fallback), so that returns 400.