Update Syslog Server (v2.2)
PUT/v2.2/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/syslogservers/:syslogserver_id
Update the syslog server.
Request
Path Parameters
ID of the tenant.
ID of the site.
ID of the element.
The syslog server configuration ID.
- application/json
Body
Details of the Syslog Server
The description of the syslog server. Max characters = 1024.
Enables export flow logs to the Syslog server.
The Syslog server field is enabled to enable the syslog server.
The ID of the Syslog server.
The Syslog server name. Max characters = 128.
The protocol type (TCP, or UDP, or TLS). The default protocol is UDP.
The standard VPN endpoint CA certificate uploaded for certificate authentication.
The Syslog server FQDN domain name.
The Syslog server IP address.
The Syslog server port number. The default port is 514 for TCP or UDP and 6514 for TLS.
The Severity Level from a severity level of critical, major, or minor.
The source interface for the Syslog server. If no value is entered for this field, then the controller port is considered as the default source interface.
The syslog profile ID.
A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
The description of the syslog server. Max characters = 1024.
Enables export flow logs to the Syslog server.
The Syslog server field is enabled to enable the syslog server.
The ID of the Syslog server.
The Syslog server name. Max characters = 128.
The protocol type (TCP, or UDP, or TLS). The default protocol is UDP.
The standard VPN endpoint CA certificate uploaded for certificate authentication.
The Syslog server FQDN domain name.
The Syslog server IP address.
The Syslog server port number. The default port is 514 for TCP or UDP and 6514 for TLS.
The Severity Level from a severity level of critical, major, or minor.
The source interface for the Syslog server. If no value is entered for this field, then the controller port is considered as the default source interface.
The syslog profile ID.
A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.
{
"enable_flow_logging": true,
"enabled": true,
"id": "string",
"name": "string",
"protocol": "string",
"remote_ca_certificate": "string",
"server_fqdn": "string",
"server_ip": "string",
"server_port": 0,
"severity_level": "string",
"source_interface": "string",
"syslog_profile_id": "string",
"tags": [
"string"
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
},
{
"code": "SYSLOGSERVER_CONFIG_IP_OR_FQDN_REQUIRED"
},
{
"code": "SYSLOGSERVER_CONFIG_INVALID_PROTOCOL"
},
{
"code": "SYSLOGSERVER_CONFIG_INVALID_RANGE"
},
{
"code": "SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL"
},
{
"code": "SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED"
},
{
"code": "SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE"
}
]
}
}