API Keys

Revoke an API key

Changed on

Revokes an API key in the organization, after which requests made with it no longer authenticate. With permissions enabled an unknown key id returns 404.

Checked against the apikey.revoke permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

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

Request

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

Path parameters

orgIdstring required
idstring required

Response

Revoked

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 non-success 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