SSH Keys

Delete an SSH public key

Changed on

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.

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

delete/v1/orgs/{orgId}/ssh-keys/{id}

Request

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

Path parameters

orgIdstring required
idstring required

Response

Deleted

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

    • 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

    • 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