Create Syslog Server Profile (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/syslogserverprofiles

Create a syslog server profile.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Details of the Syslog Server Profile

description

The description of the syslog server. Max characters = 1024.

enable_flow_logging boolean

Enables export flow logs to the Syslog server.

id string

The ID of the Syslog server.

name stringrequired

The Syslog server name. Max characters = 128.

protocol stringrequired

The protocol type (TCP, or UDP, or TLS). The default protocol is UDP.

remote_ca_certificate string

The standard VPN endpoint CA certificate uploaded for certificate authentication.

server_fqdn string

The Syslog server FQDN domain name.

server_ip string

The Syslog server IP address.

server_port int32

The Syslog server port number. The default port is 514 for TCP or UDP and 6514 for TLS.

severity_level stringrequired

The Severity Level from a severity level of critical, major, or minor.

tags string[]

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

Successful Operation

application/json

Schema

Schema

description

The description of the syslog server. Max characters = 1024.

enable_flow_logging boolean

Enables export flow logs to the Syslog server.

id string

The ID of the Syslog server.

name stringrequired

The Syslog server name. Max characters = 128.

protocol stringrequired

The protocol type (TCP, or UDP, or TLS). The default protocol is UDP.

remote_ca_certificate string

The standard VPN endpoint CA certificate uploaded for certificate authentication.

server_fqdn string

The Syslog server FQDN domain name.

server_ip string

The Syslog server IP address.

server_port int32

The Syslog server port number. The default port is 514 for TCP or UDP and 6514 for TLS.

severity_level stringrequired

The Severity Level from a severity level of critical, major, or minor.

tags string[]

A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "enable_flow_logging": true,
  "id": "string",
  "name": "string",
  "protocol": "string",
  "remote_ca_certificate": "string",
  "server_fqdn": "string",
  "server_ip": "string",
  "server_port": 0,
  "severity_level": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "SYSLOGSERVER_PROFILE_IP_OR_FQDN_REQUIRED"
      },
      {
        "code": "SYSLOGSERVER_PROFILE_INVALID_PORT_RANGE"
      },
      {
        "code": "SYSLOGSERVER_PROFILE_INVALID_PROTOCOL"
      },
      {
        "code": "SYSLOGSERVER_PROFILE_INVALID_SEVERITY_LEVEL"
      }
    ]
  }
}

Loading...