Skip to content
DashboardWebsite

Endpoints: Metrics & Audit

Telemetry and the audit log, scoped to the caller’s organization. Spans describe HTTP traffic and the product’s own work; audit events describe privileged actions: who changed what, on which target, with the values before and after. The telemetry routes require metrics:read and the audit routes audit:read, both held by admins and auditors. /admin/audit is the cross-org equivalent.

This product records two span types of its own: ingest, for every ingest through POST .../ingest and POST .../analyze, with changeset, pack and resource_count; and analysis, for every analysis submission, with resource_type, unit_address, finding_count and severity_counts. GET /analysis/metrics/summary aggregates them.

API request statistics

Request statistics for the last days days, from request spans. Requires metrics:read (admin and auditor); scoped to the caller’s own organization.

The requests block counts only spans whose auth_type is api_key. A person browsing the dashboard signs in with a session cookie; counting that would make every page reload, including the Usage page’s polling, inflate the number. GET /metrics/spans is unfiltered.

In the dashboard: Organization → Usage & Audit → Usage.

Query parameters

NameTypeRequiredDescription
daysintegernoNumber of days to aggregate

Response 200 (application/json)

{
"period_days": 7,
"requests": {
"total": 1240,
"by_status": {
"200": 900,
"201": 180,
"401": 60,
"404": 100
},
"by_method": {
"GET": 980,
"POST": 180,
"PUT": 80
},
"error_count": 160,
"error_rate_pct": 12.9,
"avg_duration_ms": 38.4
}
}

Raw span log

Spans for the caller’s organization, newest first, paged. Requires metrics:read (admin and auditor); scoped to the caller’s own organization. The platform records a request span for every HTTP request; its data has method, path, status_code and auth_type (api_key, session or anonymous). A mounted product records span types of its own.

Each span carries key_id (the API-key principal) and user_id (the session principal) as separate fields; exactly one is set, so a span can be attributed to a person without mixing them up with a machine.

Query parameters

NameTypeRequiredDescription
typestring | nullnoFilter by span type
user_idstring | nullnoFilter by human actor (session principal)
key_idstring | nullnoFilter by machine actor (API-key principal)
limitintegernoMaximum number of spans
offsetintegernoPagination offset

Response 200 (application/json)

[
{
"span_id": "3f4a...",
"trace_id": "x-request-id-value",
"type": "request",
"timestamp": "2026-01-01T12:00:00Z",
"duration_ms": 45.2,
"key_id": "config",
"data": {
"method": "GET",
"path": "/orgs/{org_id}",
"status_code": 200,
"auth_type": "api_key"
}
}
]

Request counts per API key

Request counts per API key for the last days days, highest first. Requires metrics:read (admin and auditor); scoped to the caller’s own organization. Counts only api_key-authenticated requests, so a dashboard user never appears here under their user_id as if they were a key. key_id is _anon when authentication is disabled.

Query parameters

NameTypeRequiredDescription
daysintegernoNumber of days to aggregate

Response 200 (application/json)

[
{
"key_id": "3f4a5b6c-...",
"request_count": 700
},
{
"key_id": "config",
"request_count": 540
}
]

Audit events

Audit events for the caller’s organization, newest first, paged. Requires audit:read (admin and auditor). Where spans describe the shape of HTTP traffic, audit events describe privileged actions: who changed what, on which target, with the before and after values. GET /admin/audit is the cross-org equivalent.

Each event records actor_user_id (a session) or actor_key_id (an API key), never both. actor_email is copied at write time, so the trail stays accurate if the address changes or the account is deleted. before and after hold only the fields that changed, never secrets: each call site leaves them out; the system does not filter them generically. SCIM actions record the synthetic actor_key_id scim:{org_id}, a label, not a real key.

Events are kept for retention.audit_days (730 days by default).

In the dashboard: Organization → Usage & Audit → Audit Log.

Query parameters

NameTypeRequiredDescription
actionstring | nullnoFilter by action, e.g. ‘settings.update’
actor_idstring | nullnoFilter by actor — matches either a user_id or a key_id
target_typestring | nullnoFilter by target type, e.g. ‘api_key’
sincestring | nullnoISO-8601 lower bound (inclusive)
untilstring | nullnoISO-8601 upper bound (inclusive)
limitintegernoMaximum number of events
offsetintegernoPagination offset

Response 200 (application/json)

{
"events": [
{
"event_id": "string",
"org_id": "string",
"action": "string",
"target_type": "string",
"target_id": "string",
"actor_user_id": "string",
"actor_key_id": "string",
"actor_token_id": "string",
"actor_email": "string",
"actor_is_superadmin": false,
"ip": "string",
"before": {},
"after": {},
"request_id": "string",
"timestamp": "2026-01-01T00:00:00Z"
}
],
"total_returned": 0
}

Download audit events

The same filtered query as GET /metrics/audit, as a CSV or JSON file download (Content-Disposition: attachment), up to 10,000 rows. Requires audit:read. In CSV, before and after are JSON-encoded into their own cells, since their fields vary by action.

A SIEM can poll it with an auditor API key, passing since set to the last event it stored.

Query parameters

NameTypeRequiredDescription
formatstringno‘json’ or ‘csv’
actionstring | nullno
actor_idstring | nullno
target_typestring | nullno
sincestring | nullno
untilstring | nullno
limitintegernoMaximum number of events
  • 200

Ingest and analysis telemetry for the last N days, for the caller’s organization

Ingest and analysis statistics for the last days days, from the ingest and analysis spans. Requires metrics:read (admin and auditor); scoped to the caller’s own organization. ingest.total_resources counts both POST .../ingest and POST .../analyze, which share one ingest path.

Query parameters

NameTypeRequiredDescription
daysintegernoNumber of days to aggregate

Response 200 (application/json)

{
"period_days": 7,
"ingest": {
"total": 42,
"total_resources": 310
},
"analysis": {
"total": 310,
"by_severity": {
"CRITICAL": 12,
"HIGH": 88,
"MEDIUM": 130,
"LOW": 45,
"INFO": 35
},
"avg_findings_per_resource": 2.9
}
}

Where the audit log is streamed (OpenTremor-platform#0036). An org sink receives that org’s events; a platform sink receives every event. A sink is an HTTPS endpoint (JSON or Splunk HEC) or a syslog server over TLS. Reading an org’s sinks requires audit:read; changing them requires audit_sinks:manage. The platform sinks and the drain require a superadmin.

The URL, signing secret, and auth header value are write-only: each one is enough on its own to post into the receiver.

List this org’s audit sinks

Path parameters

NameTypeRequiredDescription
org_idstringyes

Response 200 (application/json)

[
{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
]

Create an audit sink for this org

Path parameters

NameTypeRequiredDescription
org_idstringyes

Request body (application/json)

{
"name": "string",
"enabled": true,
"actions": [
"string"
],
"transport": "https",
"url": "https://example.com",
"format": "json",
"secret": "string",
"auth_header_name": "Authorization",
"auth_header_value": "string"
}
FieldTypeRequiredDescription
namestringyes
enabledbooleanno
actionsstring[]noAction prefixes to send, such as api_key. or sso.. An event is sent when its action starts with one of them. Empty sends every event.
transportstringyes
urlstring (uri)yesWhere batches are POSTed. Write-only.
format"json" | "splunk_hec"no
secretstring | nullnoSigns each body with HMAC-SHA256 as X-Signature-256: sha256=<hex>. Write-only.
auth_header_namestringno
auth_header_valuestring | nullnoSent as <auth_header_name>: <value> — Splunk <token>, or a Datadog API key with auth_header_name: DD-API-KEY. Write-only.

Response 201 (application/json)

{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
FieldTypeRequiredDescription
sink_idstringyes
scope"org" | "platform"yes
org_idstring | nullyes
namestringyes
enabledbooleanyes
transport"https" | "syslog"yes
actionsstring[]yes
url_hintstring | nullnoHost and first path segment of the URL.
format"json" | "splunk_hec" | nullno
has_secretbooleanno
auth_header_namestring | nullno
has_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno
transport_enabledbooleanyesFalse when a platform admin turned this transport off. The sink is paused and keeps its place; it resumes when the transport is turned back on.
delivered_throughstring (date-time) | nullnoEvery event stored up to this time has been delivered.
last_deliverySinkDelivery | nullno
consecutive_failuresintegerno
next_attempt_atstring (date-time) | nullno
lag_eventsinteger | nullnoEvents stored but not yet delivered, as of the last drain. Capped at 100 000.
failingbooleanyesTrue after several failed sends in a row. The dashboard shows a banner.
expiry_riskbooleanyesTrue when undelivered events are close to the audit retention window and will expire before delivery if the receiver stays down.
created_atstring (date-time)yes
updated_atstring (date-time) | nullno
  • 409 — Conflict

GET /v1/orgs/{org_id}/audit-sinks/{sink_id}

Section titled “GET /v1/orgs/{org_id}/audit-sinks/{sink_id}”

Get one of this org’s audit sinks

Path parameters

NameTypeRequiredDescription
org_idstringyes
sink_idstringyes

Response 200 (application/json)

{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
FieldTypeRequiredDescription
sink_idstringyes
scope"org" | "platform"yes
org_idstring | nullyes
namestringyes
enabledbooleanyes
transport"https" | "syslog"yes
actionsstring[]yes
url_hintstring | nullnoHost and first path segment of the URL.
format"json" | "splunk_hec" | nullno
has_secretbooleanno
auth_header_namestring | nullno
has_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno
transport_enabledbooleanyesFalse when a platform admin turned this transport off. The sink is paused and keeps its place; it resumes when the transport is turned back on.
delivered_throughstring (date-time) | nullnoEvery event stored up to this time has been delivered.
last_deliverySinkDelivery | nullno
consecutive_failuresintegerno
next_attempt_atstring (date-time) | nullno
lag_eventsinteger | nullnoEvents stored but not yet delivered, as of the last drain. Capped at 100 000.
failingbooleanyesTrue after several failed sends in a row. The dashboard shows a banner.
expiry_riskbooleanyesTrue when undelivered events are close to the audit retention window and will expire before delivery if the receiver stays down.
created_atstring (date-time)yes
updated_atstring (date-time) | nullno
  • 404 — Not Found

PATCH /v1/orgs/{org_id}/audit-sinks/{sink_id}

Section titled “PATCH /v1/orgs/{org_id}/audit-sinks/{sink_id}”

Update one of this org’s audit sinks

Partial: omitted fields are left alone. Omitting secret or auth_header_value keeps it; clear_secret and clear_auth_header remove it.

Path parameters

NameTypeRequiredDescription
org_idstringyes
sink_idstringyes

Request body (application/json)

{
"name": "string",
"enabled": true,
"actions": [
"string"
],
"url": "https://example.com",
"format": "json",
"secret": "string",
"clear_secret": false,
"auth_header_name": "string",
"auth_header_value": "string",
"clear_auth_header": false,
"host": "string",
"port": 1,
"ca_pem": "string",
"facility": 0
}
FieldTypeRequiredDescription
namestring | nullno
enabledboolean | nullno
actionsstring[] | nullnoAction prefixes to send, such as api_key. or sso.. An event is sent when its action starts with one of them. Empty sends every event.
urlstring (uri) | nullno
format"json" | "splunk_hec" | nullno
secretstring | nullno
clear_secretbooleanno
auth_header_namestring | nullno
auth_header_valuestring | nullno
clear_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno

Response 200 (application/json)

{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
FieldTypeRequiredDescription
sink_idstringyes
scope"org" | "platform"yes
org_idstring | nullyes
namestringyes
enabledbooleanyes
transport"https" | "syslog"yes
actionsstring[]yes
url_hintstring | nullnoHost and first path segment of the URL.
format"json" | "splunk_hec" | nullno
has_secretbooleanno
auth_header_namestring | nullno
has_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno
transport_enabledbooleanyesFalse when a platform admin turned this transport off. The sink is paused and keeps its place; it resumes when the transport is turned back on.
delivered_throughstring (date-time) | nullnoEvery event stored up to this time has been delivered.
last_deliverySinkDelivery | nullno
consecutive_failuresintegerno
next_attempt_atstring (date-time) | nullno
lag_eventsinteger | nullnoEvents stored but not yet delivered, as of the last drain. Capped at 100 000.
failingbooleanyesTrue after several failed sends in a row. The dashboard shows a banner.
expiry_riskbooleanyesTrue when undelivered events are close to the audit retention window and will expire before delivery if the receiver stays down.
created_atstring (date-time)yes
updated_atstring (date-time) | nullno
  • 404 — Not Found

DELETE /v1/orgs/{org_id}/audit-sinks/{sink_id}

Section titled “DELETE /v1/orgs/{org_id}/audit-sinks/{sink_id}”

Delete one of this org’s audit sinks

Path parameters

NameTypeRequiredDescription
org_idstringyes
sink_idstringyes

Response 200 (application/json)

{
"detail": "string"
}
  • 404 — Not Found

POST /v1/orgs/{org_id}/audit-sinks/{sink_id}/test

Section titled “POST /v1/orgs/{org_id}/audit-sinks/{sink_id}/test”

Send a test event to one of this org’s audit sinks

Sends one synthetic audit_sink.test event now and reports the outcome. The event is not in the audit log and does not move the sink’s place in it.

Path parameters

NameTypeRequiredDescription
org_idstringyes
sink_idstringyes

Response 200 (application/json)

{
"ok": true,
"status_code": 0,
"error": "string"
}
  • 404 — Not Found

Send every enabled sink what it has not received yet

Platform-admin only; the task scheduler calls it every minute. Safe to call at any rate: a sink in backoff or leased by another drain is skipped.

Response 200 (application/json)

{
"sinks": [
{
"sink_id": "string",
"sent": 0,
"ok": true,
"skipped": "string",
"error": "string"
}
]
}

List the platform audit sinks

Response 200 (application/json)

[
{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
]

Create a platform audit sink

Request body (application/json)

{
"name": "string",
"enabled": true,
"actions": [
"string"
],
"transport": "https",
"url": "https://example.com",
"format": "json",
"secret": "string",
"auth_header_name": "Authorization",
"auth_header_value": "string"
}
FieldTypeRequiredDescription
namestringyes
enabledbooleanno
actionsstring[]noAction prefixes to send, such as api_key. or sso.. An event is sent when its action starts with one of them. Empty sends every event.
transportstringyes
urlstring (uri)yesWhere batches are POSTed. Write-only.
format"json" | "splunk_hec"no
secretstring | nullnoSigns each body with HMAC-SHA256 as X-Signature-256: sha256=<hex>. Write-only.
auth_header_namestringno
auth_header_valuestring | nullnoSent as <auth_header_name>: <value> — Splunk <token>, or a Datadog API key with auth_header_name: DD-API-KEY. Write-only.

Response 201 (application/json)

{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
FieldTypeRequiredDescription
sink_idstringyes
scope"org" | "platform"yes
org_idstring | nullyes
namestringyes
enabledbooleanyes
transport"https" | "syslog"yes
actionsstring[]yes
url_hintstring | nullnoHost and first path segment of the URL.
format"json" | "splunk_hec" | nullno
has_secretbooleanno
auth_header_namestring | nullno
has_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno
transport_enabledbooleanyesFalse when a platform admin turned this transport off. The sink is paused and keeps its place; it resumes when the transport is turned back on.
delivered_throughstring (date-time) | nullnoEvery event stored up to this time has been delivered.
last_deliverySinkDelivery | nullno
consecutive_failuresintegerno
next_attempt_atstring (date-time) | nullno
lag_eventsinteger | nullnoEvents stored but not yet delivered, as of the last drain. Capped at 100 000.
failingbooleanyesTrue after several failed sends in a row. The dashboard shows a banner.
expiry_riskbooleanyesTrue when undelivered events are close to the audit retention window and will expire before delivery if the receiver stays down.
created_atstring (date-time)yes
updated_atstring (date-time) | nullno

Get one platform audit sink

Path parameters

NameTypeRequiredDescription
sink_idstringyes

Response 200 (application/json)

{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
FieldTypeRequiredDescription
sink_idstringyes
scope"org" | "platform"yes
org_idstring | nullyes
namestringyes
enabledbooleanyes
transport"https" | "syslog"yes
actionsstring[]yes
url_hintstring | nullnoHost and first path segment of the URL.
format"json" | "splunk_hec" | nullno
has_secretbooleanno
auth_header_namestring | nullno
has_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno
transport_enabledbooleanyesFalse when a platform admin turned this transport off. The sink is paused and keeps its place; it resumes when the transport is turned back on.
delivered_throughstring (date-time) | nullnoEvery event stored up to this time has been delivered.
last_deliverySinkDelivery | nullno
consecutive_failuresintegerno
next_attempt_atstring (date-time) | nullno
lag_eventsinteger | nullnoEvents stored but not yet delivered, as of the last drain. Capped at 100 000.
failingbooleanyesTrue after several failed sends in a row. The dashboard shows a banner.
expiry_riskbooleanyesTrue when undelivered events are close to the audit retention window and will expire before delivery if the receiver stays down.
created_atstring (date-time)yes
updated_atstring (date-time) | nullno
  • 404 — Not Found

Update one platform audit sink

Path parameters

NameTypeRequiredDescription
sink_idstringyes

Request body (application/json)

{
"name": "string",
"enabled": true,
"actions": [
"string"
],
"url": "https://example.com",
"format": "json",
"secret": "string",
"clear_secret": false,
"auth_header_name": "string",
"auth_header_value": "string",
"clear_auth_header": false,
"host": "string",
"port": 1,
"ca_pem": "string",
"facility": 0
}
FieldTypeRequiredDescription
namestring | nullno
enabledboolean | nullno
actionsstring[] | nullnoAction prefixes to send, such as api_key. or sso.. An event is sent when its action starts with one of them. Empty sends every event.
urlstring (uri) | nullno
format"json" | "splunk_hec" | nullno
secretstring | nullno
clear_secretbooleanno
auth_header_namestring | nullno
auth_header_valuestring | nullno
clear_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno

Response 200 (application/json)

{
"sink_id": "string",
"scope": "org",
"org_id": "string",
"name": "string",
"enabled": true,
"transport": "https",
"actions": [
"string"
],
"url_hint": "string",
"format": "json",
"has_secret": false,
"auth_header_name": "string",
"has_auth_header": false,
"host": "string",
"port": 0,
"ca_pem": "string",
"facility": 0,
"transport_enabled": true,
"delivered_through": "2026-01-01T00:00:00Z",
"last_delivery": {
"at": "2026-01-01T00:00:00Z",
"ok": true,
"events": 0,
"status_code": 0,
"error": "string"
},
"consecutive_failures": 0,
"next_attempt_at": "2026-01-01T00:00:00Z",
"lag_events": 0,
"failing": true,
"expiry_risk": true,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
FieldTypeRequiredDescription
sink_idstringyes
scope"org" | "platform"yes
org_idstring | nullyes
namestringyes
enabledbooleanyes
transport"https" | "syslog"yes
actionsstring[]yes
url_hintstring | nullnoHost and first path segment of the URL.
format"json" | "splunk_hec" | nullno
has_secretbooleanno
auth_header_namestring | nullno
has_auth_headerbooleanno
hoststring | nullno
portinteger | nullno
ca_pemstring | nullno
facilityinteger | nullno
transport_enabledbooleanyesFalse when a platform admin turned this transport off. The sink is paused and keeps its place; it resumes when the transport is turned back on.
delivered_throughstring (date-time) | nullnoEvery event stored up to this time has been delivered.
last_deliverySinkDelivery | nullno
consecutive_failuresintegerno
next_attempt_atstring (date-time) | nullno
lag_eventsinteger | nullnoEvents stored but not yet delivered, as of the last drain. Capped at 100 000.
failingbooleanyesTrue after several failed sends in a row. The dashboard shows a banner.
expiry_riskbooleanyesTrue when undelivered events are close to the audit retention window and will expire before delivery if the receiver stays down.
created_atstring (date-time)yes
updated_atstring (date-time) | nullno
  • 404 — Not Found

Delete one platform audit sink

Path parameters

NameTypeRequiredDescription
sink_idstringyes

Response 200 (application/json)

{
"detail": "string"
}
  • 404 — Not Found

Send a test event to one platform audit sink

Path parameters

NameTypeRequiredDescription
sink_idstringyes

Response 200 (application/json)

{
"ok": true,
"status_code": 0,
"error": "string"
}
  • 404 — Not Found