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

List an org's SSH public keys

Returns the org's SSH public keys with their fingerprints, how many live VMs each is attached to, and the VMs for which each is the only remaining key.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl ssh-keys list
GET
/v1/orgs/{orgId}/ssh-keys

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Response Body

SSH keys

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/ssh-keys'
Example Response
[  {    "id": "string",    "name": "string",    "publicKey": "string",    "fingerprint": "string",    "createdAt": "string",    "attachedVmCount": 0,    "blockingVms": [      "string"    ]  }]

Overview

Org-level SSH public keys that can be attached to VMs. Add a key and the server computes its fingerprint; list the org's keys or delete one.

Add an SSH public key (computes fingerprint) POST

Registers an OpenSSH public key for the org, stores it in canonical form with its computed fingerprint, and returns it with its new id and creation time. An invalid key answers 400 INVALID_KEY, and a key that is already registered answers 409 KEY_EXISTS.