List audit-trail events

GET

/audit-log

const url = 'https://example.com/api/v1/audit-log';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/audit-log

Recent audit-trail events, newest first, each with the actor and, for an impersonated action, the real actor behind it. Read-only; gated by audit:read:admin (admin/owner only, since the audit trail is admin-sensitive).

Parameters

Query Parameters

limit

Max rows to return, newest first (default 100, capped at 500)

integer format: int64

Max rows to return, newest first (default 100, capped at 500)

resource

Filter to one resource kind (e.g. auth, principal_grant)

string

Filter to one resource kind (e.g. auth, principal_grant)

verb

Filter to one verb (e.g. login, create)

string

Filter to one verb (e.g. login, create)

before

Only events strictly older than this RFC3339 timestamp (paging backward)

string

Only events strictly older than this RFC3339 timestamp (paging backward)

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

events

required

Array<object> | null

object

actor

string

actor_name

string

required

string

real_actor

string

real_actor_name

string

resource

required

string

resource_id

string

required

string

verb

required

string

Example

{
  "$schema": "/api/v1/schemas/AuditListOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}