Syslog Forwarders List

Syslog Forwarders List
List all configured Syslog forwarding destinations

Returns all configured Syslog forwarding destinations (maximum 2 destinations system-wide). Accessible to ADMIN, SECURITY_OPERATOR, and AUDITOR.

Request
URI
GET
https://{api_host}/api/v1/syslog-forwarders
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. Every configured syslog forwarder, at most 2

[
    {
        "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": 2,
        "lastTestAt": "2026-01-15T09:40:00Z",
        "lastTestStatus": "PASSED",
        "lastErrorMessage": null,
        "lastSuccessAt": "2026-01-15T10:15:00Z",
        "eventsForwarded": 1284,
        "bytesForwarded": 913408
    },
    {
        "forwarderId": 2,
        "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,
        "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
    }
]
array of object
Optional

Configuration profile and telemetry statistics for an outbound Syslog forwarding destination


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: 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 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 -H 'Authorization: <value>' https://{api_host}/api/v1/syslog-forwarders