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

Delete an SSH public key

Deletes an SSH public key from the org and scrubs it from every VM it was attached to, unless it is the only key that still grants access to one of them. That case is refused with 409 (code KEY_IN_USE), since deleting it would strand that VM; attach another key to those VMs first. listOrgSshKeys reports this as blockingVms.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl ssh-keys delete <id>
DELETE
/v1/orgs/{orgId}/ssh-keys/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string
id*string

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/orgs/string/ssh-keys/string'
Example Response
Empty

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.

Overview

Private container-registry credentials for pulling images: basic auth, AWS ECR or GCP GCR. Secrets are stored encrypted and never returned.