SaveSyslogForwarderRequest

SaveSyslogForwarderRequest
SaveSyslogForwarderRequest

Request payload to create or update a Syslog forwarder profile

JSON Example
{
    "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
}
string
name
Required  
Constraints: minLength: 1 maxLength: 128

Human-readable forwarder profile name

string
description
Optional

Optional narrative description

boolean
isEnabled
Optional

Whether this forwarding destination is actively processing events (default false on create)

string
host
Required  

Target destination IP address or fully qualified domain name

integer As int32 As int32
port
Required  
Constraints: minimum: 1 maximum: 65535

Destination network port (1-65535)

protocol
Optional

Transport protocol for Syslog transmission

  • TCP: A plain TCP connection with RFC 5425 octet-counting framing; the default
  • UDP: One datagram per message, clamped to 2,048 bytes
  • TLS: 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
Enumeration: TCP, UDP, TLS
format
Optional

Wire-format framing and serialization format

  • RFC5424_ICDX: RFC 5424 frames whose body is a compact ICDX JSON document; the default
  • RFC5424_STANDARD: Plain RFC 5424 syslog frames
  • CEF: Common Event Format lines (CEF:0 with vendor Broadcom and product HyperArmor)
Enumeration: RFC5424_ICDX, RFC5424_STANDARD, CEF
recordScope
Optional

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 only
  • AUDIT: Audit records only
  • SECURITY_AND_AUDIT: Security events and audit records; the default for a new destination
Enumeration: SECURITY, AUDIT, SECURITY_AND_AUDIT
boolean
tlsVerifyPeer
Optional

Whether to verify remote TLS certificate (default true)

integer As int64 As int64
clientCertId
Optional

Appliance client certificate ID for mutual TLS

integer As int64 As int64
customCaCertId
Optional

Custom CA certificate ID for private PKI trust

string
customCaPem
Optional
Constraints: maxLength: 65536

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.

integer As int32 As int32
batchSize
Optional
Constraints: minimum: 100 maximum: 100000

Keyset read batch size (100 - 100000, default 75000)

integer As int32 As int32
connectTimeoutMs
Optional
Constraints: minimum: 500 maximum: 30000

TCP/TLS connect timeout in milliseconds (500 - 30000, default 3000)

integer As int32 As int32
expectedVersion
Optional

Optimistic-concurrency token (required on update, omitted on create)