Fortinet Document Library

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

Syslog servers (/syslogservers/)

URL:  https://[server_name]/api/[api_version]/syslogservers/

This endpoint is used to create, update, edit, and delete syslog servers. This resource can be found in the FortiAuthenticator GUI under Logging > Log Config > Syslog Servers.

Supported fields

Field Display name Type Required Other restrictions
name Syslog server name string Yes  
address Syslog server IP address or syslog server name string Yes  
port Syslog server port integer Yes Default is set to 514 if not specified.
level Level of logs to record string Yes Default is set to "information" if not specified. Either "emergency", "alert", "critical", "error", "warning", "notice", "information", "debug".
facility Facility or category of logs string Yes Default is set to "user" when not specified. Either "kern", "user", "mail", "daemon", "auth", "syslog", "lpr", "news", "uucp", "cron", "authpriv", "ftp", "ntp", "audit", "alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7".

Allowed methods

HTTP method Resource URI Action
GET /api/v1/syslogservers/ Get all syslog servers.
GET /api/v1/syslogservers/[id]/ Get a specific syslog server with ID.
POST /api/v1/syslogservers/ Create a new syslog server.
PATCH /api/v1/syslogservers/[id]/ Update specified fields of an existing syslog server with ID.
DELETE /api/v1/syslogservers/[id]/ Delete a syslog server.

Syslog servers (/syslogservers/)

URL:  https://[server_name]/api/[api_version]/syslogservers/

This endpoint is used to create, update, edit, and delete syslog servers. This resource can be found in the FortiAuthenticator GUI under Logging > Log Config > Syslog Servers.

Supported fields

Field Display name Type Required Other restrictions
name Syslog server name string Yes  
address Syslog server IP address or syslog server name string Yes  
port Syslog server port integer Yes Default is set to 514 if not specified.
level Level of logs to record string Yes Default is set to "information" if not specified. Either "emergency", "alert", "critical", "error", "warning", "notice", "information", "debug".
facility Facility or category of logs string Yes Default is set to "user" when not specified. Either "kern", "user", "mail", "daemon", "auth", "syslog", "lpr", "news", "uucp", "cron", "authpriv", "ftp", "ntp", "audit", "alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7".

Allowed methods

HTTP method Resource URI Action
GET /api/v1/syslogservers/ Get all syslog servers.
GET /api/v1/syslogservers/[id]/ Get a specific syslog server with ID.
POST /api/v1/syslogservers/ Create a new syslog server.
PATCH /api/v1/syslogservers/[id]/ Update specified fields of an existing syslog server with ID.
DELETE /api/v1/syslogservers/[id]/ Delete a syslog server.