Product documentation
Siem
SIEM audit-event streaming configuration.
Siem
SIEM audit-event streaming configuration.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/siem/sinks | Siem List Sinks | tenant:siem.read |
POST | /api/v1/siem/sinks | Siem Configure Sink | tenant:siem.write |
DELETE | /api/v1/siem/sinks/{id} | Siem Delete Sink | tenant:siem.write |
GET | /api/v1/siem/sinks/{id}/health | Siem Sink Health | tenant:siem.read |
Operation details
GET /api/v1/siem/sinks
Siem List Sinks
- Operation ID:
siemListSinks - Required scopes:
tenant:siem.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer | |
cursor | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | ListEnvelopeSiemSinkResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/siem/sinks
Siem Configure Sink
- Operation ID:
siemConfigureSink - Required scopes:
tenant:siem.write
Request body (required): application/json → ConfigureSiemSinkRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/siem/sinks/{id}
Siem Delete Sink
- Operation ID:
siemDeleteSink - Required scopes:
tenant:siem.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/siem/sinks/{id}/health
Siem Sink Health
- Operation ID:
siemSinkHealth - Required scopes:
tenant:siem.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |