Configure Syslog Server
Select
This endpoint configures a syslog server.
- application/json
Request Body
- hostname string required
The hostname or the IP address of the syslog server.
- port int32
Possible values:
>= 1
and<= 65535
The port on which the syslog server accepts the logs.
- enabled boolean
Specifies if the syslog server is enabled or disabled
- secureMessaging boolean
When false UDP port will be used, when true TLS encryption will be used to connect to Syslog Server. To upload Certificate Authority file it should be enabled.
- certificateAuthorityName string
File name of the uploaded certificate authority file
- certificateAuthorityContent string
Content of the uploaded certificate authority file. It should be base64 encoded. Accepted fileTypes are key,crt,pem.
forwardToSyslog object
Select the log types that you want to forward to the syslog server.
alerts booleanForward the system log for alerts to the server.
audit booleanForward the system log for audit trails to the server.
events booleanForward the system log for events to the server.
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Bad Request
Internal Server Error