API Keys

List an org's API keys (no secrets)

Changed on

Returns the organization's API keys with each key's id, name, prefix, kind, scopes, budget, expiry and last use. The plaintext secret is never returned. With permissions enabled, a caller without apikey.read gets only their own personal keys. Dashboard playground keys are never listed.

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

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

Request

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

Path parameters

orgIdstring required

Response

API keys

createdAtstring required
createdBystring
expiresAtstring
idstring required
keyPrefixstring required
kind'personal' | 'org' | 'legacy'

Absent for a key created before permissions (legacy).

lastUsedAtstring
namestring required
notestring

Where the key is used.

ownerUserIdstring

A personal key's owner.

revokedAtstring
scopesstring[] 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

  • 551a288b9aa0Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      removed the service enum value from the / response property for the response status