Syslog Forwarders Test Unsaved

Syslog Forwarders Test Unsaved
Perform reachability test on unsaved forwarder parameters

Performs a synchronous reachability test on unsaved destination parameters before creating or updating a forwarder profile. Subject to SSRF validation. Requires ADMIN role.

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

The destination to probe: host and port, with the optional protocol, TLS verification and connect timeout. The name is not used.

SaveSyslogForwarderRequest of type(s) application/json
Required  

Show optional properties

{
    "name": "string",
    "host": "string",
    "port": 0
}
{
    "name": "Secondary collector",
    "description": "UDP collector for CEF records",
    "isEnabled": false,
    "host": "syslog.example.com",
    "port": 514,
    "protocol": "UDP",
    "format": "CEF",
    "recordScope": "SECURITY",
    "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
200

200 OK successful response envelope. The probe result with its success flag and message; nothing is saved

Returns SyslogTestResultDto of type(s) application/json
{
    "success": true,
    "dnsResolutionMs": 3,
    "tcpConnectMs": 0,
    "tlsHandshakeMs": null,
    "resolvedIp": "198.51.100.25",
    "message": "UDP test datagram transmitted successfully (delivery unverifiable on connectionless transport)"
}
boolean
success
Required  

Whether network connectivity / TLS handshake succeeded

integer As int64 As int64
dnsResolutionMs
Required  

DNS lookup duration in milliseconds

integer As int64 As int64
tcpConnectMs
Required  

TCP socket connection duration in milliseconds

integer As int64 As int64
tlsHandshakeMs
Optional

TLS handshake duration in milliseconds (null for plain TCP/UDP)

string
resolvedIp
Required  

Resolved destination IP address

string
message
Required  

Descriptive outcome or diagnostic failure reason


400

400 Bad Request: 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.


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/test