System Logs
System logs capture operational telemetry — errors, warnings, info traces, and structured events emitted by the platform during normal operation. These are the right surface for diagnosing why something failed, tracking a request through the system, or spotting recurring issues.
For security-relevant events (sign-ins, permission changes, configuration changes), see Audit Logs instead.
Scopes
| Scope | Reach |
|---|---|
logging:read | Listing, reading system logs, viewing filters. |
logging:write | Deleting system log entries. |
Endpoints
List System Logs
GET /api/logging/system/
Returns a page of system-log entries.
Required scope: logging:read · also accepts API key
Query parameters — standard pagination set; see Conventions › Pagination. Defaults: sort_by=timestamp, sort_order=desc. (No hydrate flag on this resource.)
Response 200 — SystemLogInDbCursorPage
Get System Log Filter Metadata
GET /api/logging/system/filters
Returns filter/operator/sort options for List System Logs.
Required scope: logging:read
Response 200 — open metadata object.
Get System Log by ID
GET /api/logging/system/{id}
Returns a single system-log entry.
Required scope: logging:read · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | System log ID. |
Response 200 — LogRead
Delete System Log by ID
DELETE /api/logging/system/{id}
Permanently removes a system-log entry. Typically used for noise control rather than retention policy (audit logs are the compliance surface).
Required scope: logging:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | System log ID. |
Response 204 — empty.
See also
- Audit Logs — security-relevant events (who did what when).
- Admin › System Health — point-in-time service health snapshots that complement long-form logs.