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 accessAccess

Get the organization's key settings

Returns the organization's maximum API key lifetime in days (0 means keys may never expire), with who last changed it and when.

Required permission

Requires the policy.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl authz key-setting get
GET
/v1/authz/settings

Authorization

apiKey
headerAuthorizationBearer <token>

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

Response Body

Settings

application/json
  1. response
maxKeyLifetimeDays*integer

New keys must expire within this many days; 0 means keys may never expire.

Range0 <= value <= 3650
updatedBy?string
updatedAt?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/authz/settings'
Example Response
{  "maxKeyLifetimeDays": 0,  "updatedBy": "string",  "updatedAt": "string"}

Delete a policy DELETE

Deletes a guardrail or custom policy and returns 204. A delete is refused with 403 when removing the policy would let the organization do what you cannot. Requires a signed-in session and the permission creating the policy needs.

Set the maximum key lifetime PUT

Sets maxKeyLifetimeDays, from 0 to 3650, and returns the saved settings. New API keys must expire within that many days; 0 lets keys never expire. Requires a signed-in session.