Syslog Forwarders Create

Syslog Forwarders Create
Create a new Syslog forwarder profile

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.

Request
URI
POST
https://{api_host}/api/v1/syslog-forwarders
COPY
Request Body

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.

SaveSyslogForwarderRequest of type(s) application/json
Required  

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
}
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)

string
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
string
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
string
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)

Authentication
This operation uses the following authentication methods.
Responses
201

201 Created successful response envelope. The created forwarder profile

Returns SyslogForwarderDto of type(s) application/json
{
    "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
}
integer As int64 As int64
forwarderId
Required  

Unique canonical identifier for the forwarder

string
name
Required  

Human-readable forwarder profile name

string
description
Optional

Optional narrative description

boolean
isEnabled
Required  

Whether this forwarding destination is actively processing events

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)

string
protocol
Required  

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
string
format
Required  

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
string
recordScope
Required  

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
Required  

Whether to verify remote TLS certificate

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
customCaSubject
Optional

Subject of the destination's private CA certificate (first certificate of the pasted bundle); absent when none is configured

string
customCaFingerprintSha256
Optional

SHA-256 fingerprint of the private CA certificate, colon-separated upper-case hex; absent when none is configured

string As date-time As date-time
customCaNotAfter
Optional

Expiry of the private CA certificate; absent when none is configured

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

Configured batch size for keyset read (100 - 100000)

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

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

integer As int32 As int32
version
Required  

Optimistic-concurrency version token

string As date-time As date-time
lastTestAt
Optional

Timestamp of last reachability test

string
lastTestStatus
Optional

Operational connectivity test status

  • PASSED: The last connectivity test to the destination succeeded
  • FAILED: The last connectivity test to the destination failed
  • NEVER_TESTED: No connectivity test has run for the destination; the status of a newly created destination
Enumeration: PASSED, FAILED, NEVER_TESTED
string
lastErrorMessage
Optional

Last error message recorded during forwarding or testing

string As date-time As date-time
lastSuccessAt
Optional

Timestamp of last successful event delivery

integer As int64 As int64
eventsForwarded
Required  

Total lifetime forwarded event count

integer As int64 As int64
bytesForwarded
Required  

Total lifetime forwarded payload bytes


400

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

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

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)

Returns ForbiddenWrite of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

409 Conflict error response (DUPLICATE_NAME or DESTINATION_COUNT_EXCEEDED)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    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