Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceAccount and accessAudit Events

List the org's access audit log, newest first

Every change to keys, members, roles, service accounts and policies, kept for 365 days. Filter by actor, event, target or time; 50 per page by default.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl audit-events list
GET
/v1/audit-events

Authorization

apiKey
headerAuthorizationBearer <token>

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

Query Parameters

actor?string
event?string
targetId?string
since?string

RFC 3339 lower bound.

until?string

RFC 3339 upper bound.

limit?integer
Range1 <= value <= 200
cursor?string

Response Body

Events

application/json
  1. response
items*array<>
nextCursor?string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/audit-events'
Example Response
{  "items": [    {      "id": "string",      "actor": "string",      "event": "string",      "targetType": "string",      "targetId": "string",      "before": "string",      "after": "string",      "sourceIp": "string",      "requestId": "string",      "createdAt": "string"    }  ],  "nextCursor": "string"}