SIEM

Update a SIEM destination

Partially updates a saved destination. Omitted credentials retain their stored values.

Required scope: siem:write

patch/siem/destinations/{destination_id}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/siem/destinations/{destination_id}
  • Auth: API key in header API-Key

Path parameters

destination_idstring uuid required

Headers

API-Version'2026-06-01.beta' required

Request body

namestring
enabledboolean

Example request

{
  "source": {
    "realms": [
      "customer-portal"
    ]
  }
}

Response

The request has succeeded.

idstring uuid required
namestring required
enabledboolean required
type'syslog' | 's3' | 'http' required

External SIEM destination type.

health_status'healthy' | 'degraded' | 'failed' required
failure_countinteger required
last_errorstring
last_sent_atstring date-time
total_events_sentinteger required
total_logs_sentinteger required
total_bytes_sentinteger required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "source": {
    "realms": [
      "customer-portal"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.