SaveSyslogForwarderRequest
Request payload to create or update a Syslog forwarder profile
{
"name": "string",
"description": "string",
"isEnabled": false,
"host": "string",
"port": 0,
"protocol": "string",
"format": "string",
"recordScope": "string",
"tlsVerifyPeer": false,
"clientCertId": 0,
"customCaCertId": 0,
"customCaPem": "string",
"batchSize": 0,
"connectTimeoutMs": 0,
"expectedVersion": 0
}
Human-readable forwarder profile name
Optional narrative description
Whether this forwarding destination is actively processing events (default false on create)
Target destination IP address or fully qualified domain name
Destination network port (1-65535)
Transport protocol for Syslog transmission
TCP: A plain TCP connection with RFC 5425 octet-counting framing; the defaultUDP: One datagram per message, clamped to 2,048 bytesTLS: A TCP connection upgraded to TLS with the same octet-counting framing; the peer certificate chain and host name are verified unless the destination sets tlsVerifyPeer to false
Wire-format framing and serialization format
RFC5424_ICDX: RFC 5424 frames whose body is a compact ICDX JSON document; the defaultRFC5424_STANDARD: Plain RFC 5424 syslog framesCEF: Common Event Format lines (CEF:0 with vendor Broadcom and product HyperArmor)
Stream selection - which unfiltered streams this destination receives. The request field is typed with the server's own enum, which also accepts ALERT, SECURITY_AND_ALERT, AUDIT_AND_ALERT and ALL (alert records included); this list does not show them
SECURITY: Security events onlyAUDIT: Audit records onlySECURITY_AND_AUDIT: Security events and audit records; the default for a new destination
Whether to verify remote TLS certificate (default true)
Appliance client certificate ID for mutual TLS
Custom CA certificate ID for private PKI trust
PEM text of the private CA certificate(s) the destination must trust (TLS only, at most 10 certificates, 64 KiB). Public certificates only; a private key is refused. Send it to set or replace the CA. Omit it and send customCaCertId unchanged to keep the stored CA; omit both to remove it. Never returned.
Keyset read batch size (100 - 100000, default 75000)
TCP/TLS connect timeout in milliseconds (500 - 30000, default 3000)
Optimistic-concurrency token (required on update, omitted on create)