Siem

Base URL: $BUSINESS_API

The object

destinationsarray of AuditSiemDestination · required

Every destination of the tenant, without credentials.

Show child attributes
idstring · optional

Destination identifier.

tenant_idstring · optional

Tenant whose audit events are delivered.

namestring · optional

Display name.

providerstring · optional

Delivery adapter.

one of webhook, splunk, datadog, cloudwatch, elastic

endpoint_urlstring · optional

Receiving URL.

formatstring · optional

Event encoding.

one of cloudevents, cef

regionstring · optional

Cloud region (cloudwatch only).

log_groupstring · optional

Log group (cloudwatch only).

log_streamstring · optional

Log stream (cloudwatch only).

indexstring · optional

Index name (elastic only).

aws_access_key_idstring · optional

Access key ID (cloudwatch only).

has_auth_headerboolean · optional

Whether an auth_header credential is stored.

has_secretboolean · optional

Whether a signing secret is stored.

has_aws_secretboolean · optional

Whether a secret access key is stored.

enabledboolean · optional

Whether events are delivered.

created_atstring (date-time) · optional

When the destination was created.

updated_atstring (date-time) · optional

When the destination was last changed.

The object
{
  "destinations": [
    {
      "id": "sie_01JD3X8Q7M2N4P5R6S7T8V9W0X",
      "tenant_id": "tenant_alpha",
      "name": "Ana Matsinhe",
      "provider": "webhook",
      "endpoint_url": "https://example.org/",
      "format": "cloudevents",
      "region": "region",
      "log_group": "log group",
      "log_stream": "log stream",
      "index": "index",
      "aws_access_key_id": "aws_2cIFP6uV3uoDZEabDAAHdwChHMM",
      "has_auth_header": true,
      "has_secret": true,
      "has_aws_secret": true,
      "enabled": true,
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ]
}

Show the tenant's audit event destinations

Logs

GET /siem

Returns every destination that receives the caller's tenant audit events in real time, wrapped in a destinations array (not paged). Credentials are never returned; the has_auth_header, has_secret and has_aws_secret flags report which are stored. Requires audit:read.

Returns

200 Audit event destinations

Show attributes
destinationsarray of AuditSiemDestination · required

Every destination of the tenant, without credentials.

Show child attributes
idstring · optional

Destination identifier.

tenant_idstring · optional

Tenant whose audit events are delivered.

namestring · optional

Display name.

providerstring · optional

Delivery adapter.

one of webhook, splunk, datadog, cloudwatch, elastic

endpoint_urlstring · optional

Receiving URL.

formatstring · optional

Event encoding.

one of cloudevents, cef

regionstring · optional

Cloud region (cloudwatch only).

log_groupstring · optional

Log group (cloudwatch only).

log_streamstring · optional

Log stream (cloudwatch only).

indexstring · optional

Index name (elastic only).

aws_access_key_idstring · optional

Access key ID (cloudwatch only).

has_auth_headerboolean · optional

Whether an auth_header credential is stored.

has_secretboolean · optional

Whether a signing secret is stored.

has_aws_secretboolean · optional

Whether a secret access key is stored.

enabledboolean · optional

Whether events are delivered.

created_atstring (date-time) · optional

When the destination was created.

updated_atstring (date-time) · optional

When the destination was last changed.

Errors 401 · 403

Permissions audit:read · Roles: admin, analyst, owner

curl -X GET "$BUSINESS_API/siem" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "destinations": [
    {
      "id": "sie_01JD3X8Q7M2N4P5R6S7T8V9W0X",
      "tenant_id": "tenant_alpha",
      "name": "Ana Matsinhe",
      "provider": "webhook",
      "endpoint_url": "https://example.org/",
      "format": "cloudevents",
      "region": "region",
      "log_group": "log group",
      "log_stream": "log stream",
      "index": "index",
      "aws_access_key_id": "aws_2cIFP6uV3uoDZEabDAAHdwChHMM",
      "has_auth_header": true,
      "has_secret": true,
      "has_aws_secret": true,
      "enabled": true,
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ]
}

Add a destination for real-time audit events

Logs

POST /siem

Creates a destination that receives each new audit event of the caller's tenant. provider defaults to webhook and format to cloudevents (cef is the alternative). name is required and endpoint_url must be a public https address; cloudwatch also needs region, log_group, log_stream and both access keys (endpoint_url then defaults to the regional logs endpoint), and elastic needs index. auth_header, secret and aws_secret_access_key are write-only: they are encrypted at rest and never returned. Unknown fields or a failed validation return 400. Requires audit:manage. Needs a person's session: API keys are refused with 403 and code api_key_not_allowed, whatever scopes they hold.

Body application/json

namestring · required

Display name. Must not be blank.

providerstring · optional

Delivery adapter. Defaults to webhook.

one of webhook, splunk, datadog, cloudwatch, elastic

endpoint_urlstring (uri) · optional

Receiving URL; must be a public https address. Required, except for cloudwatch, where it defaults to the regional logs endpoint.

auth_headerstring · optional

Credential sent with each delivery (as the Authorization header, or the provider's API key header). With provider splunk or elastic, a value without a space gets the provider's scheme prefix. Write-only.

formatstring · optional

Event encoding. Defaults to cloudevents.

one of cloudevents, cef

secretstring · optional

Shared secret used to sign each delivered body with HMAC-SHA256 in a signature header. Write-only.

regionstring · optional

Cloud region, required for cloudwatch (for example eu-west-1).

log_groupstring · optional

Log group, required for cloudwatch.

log_streamstring · optional

Log stream, required for cloudwatch.

indexstring · optional

Index name, required for elastic.

aws_access_key_idstring · optional

Access key ID, required for cloudwatch.

aws_secret_access_keystring · optional

Secret access key, required for cloudwatch. Write-only.

enabledboolean · optional

Whether events are delivered. Defaults to true.

Returns

201 Destination created, without credentials

Show attributes
idstring · optional

Destination identifier.

tenant_idstring · optional

Tenant whose audit events are delivered.

namestring · optional

Display name.

providerstring · optional

Delivery adapter.

one of webhook, splunk, datadog, cloudwatch, elastic

endpoint_urlstring · optional

Receiving URL.

formatstring · optional

Event encoding.

one of cloudevents, cef

regionstring · optional

Cloud region (cloudwatch only).

log_groupstring · optional

Log group (cloudwatch only).

log_streamstring · optional

Log stream (cloudwatch only).

indexstring · optional

Index name (elastic only).

aws_access_key_idstring · optional

Access key ID (cloudwatch only).

has_auth_headerboolean · optional

Whether an auth_header credential is stored.

has_secretboolean · optional

Whether a signing secret is stored.

has_aws_secretboolean · optional

Whether a secret access key is stored.

enabledboolean · optional

Whether events are delivered.

created_atstring (date-time) · optional

When the destination was created.

updated_atstring (date-time) · optional

When the destination was last changed.

Errors 400 · 401 · 403

Permissions audit:manage · Roles: admin, owner

curl -X POST "$BUSINESS_API/siem" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Security operations",
  "provider": "webhook",
  "endpoint_url": "https://siem.example.com/ingest",
  "auth_header": "auth header",
  "format": "cloudevents",
  "secret": "secret",
  "region": "eu-west-1",
  "log_group": "log group",
  "log_stream": "log stream",
  "index": "index",
  "aws_access_key_id": "aws_2cIFP6uV3uoDZEabDAAHdwChHMM",
  "aws_secret_access_key": "aws secret access key",
  "enabled": true
}'
Response 201
{
  "id": "sie_01JD3X8Q7M2N4P5R6S7T8V9W0X",
  "tenant_id": "tenant_alpha",
  "name": "Ana Matsinhe",
  "provider": "webhook",
  "endpoint_url": "https://example.org/",
  "format": "cloudevents",
  "region": "region",
  "log_group": "log group",
  "log_stream": "log stream",
  "index": "index",
  "aws_access_key_id": "aws_2cIFP6uV3uoDZEabDAAHdwChHMM",
  "has_auth_header": true,
  "has_secret": true,
  "has_aws_secret": true,
  "enabled": true,
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Read one audit event destination

Logs

GET /siem/{id}

Returns one destination of the caller's tenant, without credentials. Requires audit:read; an unknown id returns 404.

Parameters

idstring · path · required

Identifier of the destination (sie_...).

Returns

200 The destination

Show attributes
idstring · optional

Destination identifier.

tenant_idstring · optional

Tenant whose audit events are delivered.

namestring · optional

Display name.

providerstring · optional

Delivery adapter.

one of webhook, splunk, datadog, cloudwatch, elastic

endpoint_urlstring · optional

Receiving URL.

formatstring · optional

Event encoding.

one of cloudevents, cef

regionstring · optional

Cloud region (cloudwatch only).

log_groupstring · optional

Log group (cloudwatch only).

log_streamstring · optional

Log stream (cloudwatch only).

indexstring · optional

Index name (elastic only).

aws_access_key_idstring · optional

Access key ID (cloudwatch only).

has_auth_headerboolean · optional

Whether an auth_header credential is stored.

has_secretboolean · optional

Whether a signing secret is stored.

has_aws_secretboolean · optional

Whether a secret access key is stored.

enabledboolean · optional

Whether events are delivered.

created_atstring (date-time) · optional

When the destination was created.

updated_atstring (date-time) · optional

When the destination was last changed.

Errors 401 · 403 · 404

Permissions audit:read · Roles: admin, analyst, owner

curl -X GET "$BUSINESS_API/siem/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "sie_01JD3X8Q7M2N4P5R6S7T8V9W0X",
  "tenant_id": "tenant_alpha",
  "name": "Ana Matsinhe",
  "provider": "webhook",
  "endpoint_url": "https://example.org/",
  "format": "cloudevents",
  "region": "region",
  "log_group": "log group",
  "log_stream": "log stream",
  "index": "index",
  "aws_access_key_id": "aws_2cIFP6uV3uoDZEabDAAHdwChHMM",
  "has_auth_header": true,
  "has_secret": true,
  "has_aws_secret": true,
  "enabled": true,
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Remove an audit event destination

Logs

DELETE /siem/{id}

Deletes the destination with this id from the caller's tenant; events are no longer delivered to it. The call is idempotent and returns 204 for an unknown id. Requires audit:manage. Needs a person's session: API keys are refused with 403 and code api_key_not_allowed, whatever scopes they hold.

Parameters

idstring · path · required

Identifier of the destination to remove (sie_...).

Returns

204 Destination removed

Errors 401 · 403

Permissions audit:manage · Roles: admin, owner

curl -X DELETE "$BUSINESS_API/siem/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 204

Destination removed

Send a test event to an audit event destination

Logs

POST /siem/{id}/test

Delivers a synthetic siem.connection.test event to the destination with its stored credentials and format and waits for the receiver to accept it. A refused or failed delivery returns 400. Takes no request body. Requires audit:manage; an unknown id returns 404. Needs a person's session: API keys are refused with 403 and code api_key_not_allowed, whatever scopes they hold.

Parameters

idstring · path · required

Identifier of the destination to test (sie_...).

Returns

200 The destination accepted the test event

Show attributes
statusstring · required

Always ok.

messagestring · required

Human-readable confirmation.

Errors 400 · 401 · 403 · 404

Permissions audit:manage · Roles: admin, owner

curl -X POST "$BUSINESS_API/siem/{id}/test" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "status": "ok",
  "message": "Test event dispatched successfully"
}