API Keys

Edit an API key budget

Changed on

Sets, changes or removes an API key's spend budget and returns the key with its current spend. A limitNanoUsd of 0 removes the budget. Requires a signed-in session: your own key, or apikeys.write for any key. In organizations with permissions enabled, only the budget can be edited. Name, note and restrictions return 400. Available with permissions enabled; otherwise 404.

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

patch/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

Request body

namestring
notestring

Response

Updated

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

    • 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