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

Request access to a product

Submits a request for access to a product, from the dashboard's Request access flow. An operator reviews it in the ops queue.

Required permission

Requires the accessrequest.create permission. See Permissions for the roles and API key permissions that include it.

POST
/v1/access-requests

Authorization

apiKey
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
product*string
Lengthlength <= 64
fullName*string
Lengthlength <= 120
workEmail*string
Lengthlength <= 200
company?string
Lengthlength <= 160
useCase*string
Lengthlength <= 2000

Response Body

Created

application/json
  1. response
id*string
status*"new"
Value in"new"
Example Request
curl -X POST 'https://api.openrelay.inc/v1/access-requests' \  -H 'Content-Type: application/json' \  -d '{  "product": "string",  "fullName": "string",  "workEmail": "string",  "useCase": "string"}'
Example Response
{  "id": "string",  "status": "new"}

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.

Overview

The organization's access audit log. Available to organizations with permissions enabled; otherwise this endpoint returns 404.