SSH Keys

List an org's SSH public keys

Changed on

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.

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

get/v1/orgs/{orgId}/ssh-keys

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/ssh-keys
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Response

SSH keys

attachedVmCountinteger

Number of live (non-terminated) VMs this key is attached to. Zero means the key is not scoped to any VM. The dashboard shows an "in use" indicator and warns before deleting a key that is in use.

blockingVmsstring[]

Names of VMs for which this is the only key that still resolves to a live org key. Deleting the key is refused (409) while this is non-empty; attach another key to those VMs first.

createdAtstring required
fingerprintstring required
idstring required
namestring required
publicKeystring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status