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

Add an SSH public key (computes fingerprint)

Command line

The orl CLI wraps this endpoint:

orl ssh-keys create --name <name> --public-key <public-key>
POST
/v1/orgs/{orgId}/ssh-keys/create

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

orgId*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/orgs/string/ssh-keys/create" \  -H "Content-Type: application/json" \  -d '{    "name": "work-laptop",    "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIB5ro6Vg2mXKC3jExample user@laptop"  }'
{  "id": "string",  "name": "string",  "publicKey": "string",  "fingerprint": "string",  "createdAt": "string",  "attachedVmCount": 0,  "blockingVms": [    "string"  ]}

List an org's SSH public keys GET

Previous Page

Delete an SSH public key DELETE

Removes the key from the org and scrubs it from every VM it was attached to. Refused with 409 (code KEY_IN_USE) when it is the only key that still grants access to a VM, since deleting it would strand that VM; attach another key to those VMs first. listOrgSshKeys reports this as blockingVms.