Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceAccount and accessAPI Keys

Revoke an API key

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl api-keys delete <id>
DELETE
/v1/orgs/{orgId}/api-keys/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string
id*string

Response Body

Revoked

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/orgs/string/api-keys/string'
Example Response
Empty

Edit an API key budget PATCH

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.

Overview

Built-in and custom roles. A custom role is a set of permissions plus optional model, endpoint and network conditions. Available to organizations with permissions enabled; otherwise these endpoints return 404.