Update SIEM/webhook destination metadata and write-only delivery refs. PUT
/v1/siem-webhooks/{destination_id}
Select media type application/json object Allowed values: siem webhook audit_export
Opaque gateway-owned destination handle. Raw http(s) URLs, path/query token shapes, and secret-bearing endpoint material are rejected; real endpoint/token values use write-only reference fields.
string
/^(otel|siem|webhook|audit-export|disabled)://(?!.*(?:secret|token|password|api_key|client_secret))[a-z0-9][a-z0-9_-]{0,127}$/
Opaque gateway-owned destination handle. Raw http(s) URLs, path/query token shapes, and secret-bearing endpoint material are rejected; real endpoint/token values use write-only reference fields.
string
/^(otel|siem|webhook|audit-export|disabled)://(?!.*(?:secret|token|password|api_key|client_secret))[a-z0-9][a-z0-9_-]{0,127}$/
write_only_secret_ref
Optional signing/token reference accepted only on write and never returned.
string
retention_policy required
object metadata_retention_days required
Allowed values: metadata otlp_metadata siem_ndjson_metadata webhook_json_metadata
object include_payloads required
private_payload_egress required
secret_material_returned required
no_payload_guarantee required
audit_material
Allowed values: metadata_only
Destination updated and audited.
Select media type application/json object Allowed values: siem webhook audit_export
Opaque gateway-owned destination handle. Raw http(s) URLs, path/query token shapes, and secret-bearing endpoint material are rejected; real endpoint/token values use write-only reference fields.
string
/^(otel|siem|webhook|audit-export|disabled)://(?!.*(?:secret|token|password|api_key|client_secret))[a-z0-9][a-z0-9_-]{0,127}$/
Opaque gateway-owned destination handle. Raw http(s) URLs, path/query token shapes, and secret-bearing endpoint material are rejected; real endpoint/token values use write-only reference fields.
string
/^(otel|siem|webhook|audit-export|disabled)://(?!.*(?:secret|token|password|api_key|client_secret))[a-z0-9][a-z0-9_-]{0,127}$/
siem_delivery_status required
object Allowed values: healthy degraded failed disabled unknown
object Allowed values: healthy degraded failed disabled unknown
audit_export_status required
object Allowed values: healthy degraded failed disabled unknown
audit_export_link required
object admin_api_operation required
duplicates_export_jobs required
retention_policy required
object metadata_retention_days required
Allowed values: metadata otlp_metadata siem_ndjson_metadata webhook_json_metadata
object include_payloads required
private_payload_egress required
secret_material_returned required
no_payload_guarantee required
audit_material
Allowed values: metadata_only
object Array
Allowed values: read create update test disable
Caller lacks permission to update this destination.
Select media type application/json object Allowed values: redacted metadata_only
field
Optional metadata-only field identifier for validation errors.
string
details
Optional metadata-only diagnostic details. Never include secret material, payloads, prompts, raw endpoint URLs, or customer data.
object key additional properties
Destination not found in tenant/environment scope.
Select media type application/json object Allowed values: redacted metadata_only
field
Optional metadata-only field identifier for validation errors.
string
details
Optional metadata-only diagnostic details. Never include secret material, payloads, prompts, raw endpoint URLs, or customer data.
object key additional properties
Type set in Geist, Source Serif 4, and
Departure Mono .
