Skip to main content
PUT
Update SIEM destination
Check delivery_available in the list response before enabling a destination. Delivery covers new audit events with verified environment attribution. Historical and unattributed events are not streamed. An enabled destination is not evidence of successful ingestion; inspect delivery_counts and your receiver.
Use the API key for the intended sandbox or production environment. Listing requires audit:read; changes require audit:write. A browser session must belong to a workspace administrator. A destination from another tenant or environment cannot be updated or deleted. Credentials are encrypted at rest and never appear in responses. For webhooks supply secret; for Splunk, Datadog or Elastic supply token. Changing an endpoint requires supplying its credential again. CloudWatch configuration is not supported. An environment can hold up to 20 destinations. Deleting a destination removes its saved credential and queued delivery records. Disabling or changing a destination cancels its pending deliveries; save any delivery evidence you need first. See the SIEM delivery guide for retries, provider settings and webhook verification. For snapshot ingestion, use audit exports or risk-event exports. These exports do not enable continuous streaming.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

id
string<uuid>
required

SIEM destination ID.

Body

application/json
endpoint
string<uri>

Public HTTPS hostname on port 443, without user credentials, query parameters or fragment. Changing the endpoint requires supplying the credential again. Saving does not validate ownership or delivery.

Maximum string length: 2048
token
string
write-only

Token for Splunk, Datadog or Elastic configuration. Required at creation for these providers. Do not supply secret as well.

Required string length: 16 - 8192
secret
string
write-only

Shared secret for webhook configuration. Required at creation for webhook. Do not supply token as well.

Required string length: 16 - 8192
enabled
boolean
default:false

Enable delivery of newly recorded environment-attributed audit events. Requires delivery_available=true; otherwise true returns 409. Defaults to false when creating a destination.

Response

Updated SIEM destination.

id
string<uuid>
environment_id
string<uuid>
provider
enum<string>
Available options:
splunk,
datadog,
elastic,
webhook
endpoint
string<uri>
enabled
boolean
status
enum<string>
Available options:
configured_delivery_unavailable,
disabled,
enabled
credential_configured
boolean
created_at
string<date-time>
updated_at
string<date-time>