Skip to main content

Configure Syslog Server​

Select

SaaS
Customer Managed

This endpoint configures a syslog server.

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 boolean

    Forward the system log for alerts to the server.

  • audit boolean

    Forward the system log for audit trails to the server.

  • events boolean

    Forward the system log for events to the server.

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
POST /v4/syslogserver

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "hostname": "string",

  "port": 0,

  "enabled": true,

  "secureMessaging": true,

  "certificateAuthorityName": "string",

  "certificateAuthorityContent": "string",

  "forwardToSyslog": {

    "alerts": true,

    "audit": true,

    "events": true

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/syslogServer' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "hostname": "string",
  "port": 0,
  "enabled": true,
  "secureMessaging": true,
  "certificateAuthorityName": "string",
  "certificateAuthorityContent": "string",
  "forwardToSyslog": {
    "alerts": true,
    "audit": true,
    "events": true
  }
}'