Syslog Forwarders Create
Configures a new outbound Syslog forwarding destination (max 2 destinations system-wide). Initializes watermark to now - 5 minutes. Validates destination host/port against SSRF rules. Requires ADMIN role.
The forwarder settings: name, destination host and port, protocol and format, and the optional TLS and batching options. On update, expectedVersion, when sent, must be the stored version.
Show optional properties
{
"name": "string",
"host": "string",
"port": 0
}
{
"name": "Primary SIEM",
"description": "Security operations syslog collector",
"isEnabled": true,
"host": "siem.example.com",
"port": 6514,
"protocol": "TLS",
"format": "RFC5424_ICDX",
"recordScope": "SECURITY_AND_AUDIT",
"tlsVerifyPeer": true,
"clientCertId": null,
"customCaCertId": null,
"batchSize": 75000,
"connectTimeoutMs": 3000,
"expectedVersion": null
}
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)
201 Created successful response envelope. The created forwarder profile
{
"forwarderId": 1,
"name": "Primary SIEM",
"description": "Security operations syslog collector",
"isEnabled": true,
"host": "siem.example.com",
"port": 6514,
"protocol": "TLS",
"format": "RFC5424_ICDX",
"recordScope": "SECURITY_AND_AUDIT",
"tlsVerifyPeer": true,
"clientCertId": null,
"customCaCertId": null,
"customCaSubject": null,
"customCaFingerprintSha256": null,
"customCaNotAfter": null,
"batchSize": 75000,
"connectTimeoutMs": 3000,
"version": 1,
"lastTestAt": null,
"lastTestStatus": "NEVER_TESTED",
"lastErrorMessage": null,
"lastSuccessAt": null,
"eventsForwarded": 0,
"bytesForwarded": 0
}
Unique canonical identifier for the forwarder
Human-readable forwarder profile name
Optional narrative description
Whether this forwarding destination is actively processing events
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
Appliance client certificate ID for mutual TLS
Custom CA certificate ID for private PKI trust
Subject of the destination's private CA certificate (first certificate of the pasted bundle); absent when none is configured
SHA-256 fingerprint of the private CA certificate, colon-separated upper-case hex; absent when none is configured
Expiry of the private CA certificate; absent when none is configured
Configured batch size for keyset read (100 - 100000)
TCP/TLS connect timeout in milliseconds (500 - 30000)
Optimistic-concurrency version token
Timestamp of last reachability test
Operational connectivity test status
PASSED: The last connectivity test to the destination succeededFAILED: The last connectivity test to the destination failedNEVER_TESTED: No connectivity test has run for the destination; the status of a newly created destination
Last error message recorded during forwarding or testing
Timestamp of last successful event delivery
Total lifetime forwarded event count
Total lifetime forwarded payload bytes
400 Bad Request: INVALID_NAME when the name is blank; INVALID_DESTINATION_HOST when the host is blank, does not resolve, or resolves to a loopback, link-local or unroutable address, or to a private address unless private destinations are allowed; INVALID_DESTINATION_PORT when the port is outside 1 to 65535; MALFORMED_REQUEST when the body cannot be read
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
409 Conflict error response (DUPLICATE_NAME or DESTINATION_COUNT_EXCEEDED)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string","host":"string","port":"integer"}' https://{api_host}/api/v1/syslog-forwarders