Get all syslog profiles
GET/logging-service/logforwarding/v1/syslog-profiles
Retrieve information about all existing syslog profiles, including their profile IDs.
Request
Query Parameters
Possible values: [pending
, inactive
, active
]
The status of the profiles to be returned.
Default value: 100
The maximum number of profiles to be returned.
Responses
- 200
- 400
- 429
- 500
- 503
Request successfully processed
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
destination objectrequired
Profile name, output, and syslog receiver information.
Name of the profile.
Syslog facility value as per IETF standards.
An email address to receive updates about log transmission.
Character that separates log fields. Based on log format.
Possible values: [CSV
, LEEF
, CEF
]
The format in which to send logs.
Possible values: <= 65535
The port on which to send logs.
A token used to uniquely identify your logs to a cloud-based syslog service.
IP address or FQDN of your syslog server.
logtypes object[]required
True
sends all log fields. False
sends a subset of log fields.
The specific log fields you do not want to send. Does nothing if the same field is present in includedColumns
.
The filter query used to send a subset of logs.
The specific log fields you want to send. Does nothing if allColumns
is True
.
The log type that you want to send.
Possible values: [pending
, inactive
, active
]
Profile status
[
{
"destination": {},
"logtypes": [
{
"allColumns": false,
"excludedColumns": [
"string"
],
"filter": "log_time = '2022-09-04T01:00:01.000Z' AND vsys != ''",
"includedColumns": [
"log_time",
"vsys"
],
"logtype": "firewall.traffic"
}
],
"profileId": "bd69764a-af85-4a66-8fb0-7df1a4317c65",
"status": "pending"
}
]
Invalid input
- application/json
- Schema
- Example (from schema)
Schema
Server error code
A message describing the error code
{
"errorCode": 0,
"errorMessage": "string"
}
Too many request
LogForwarding Service internal error
- application/json
- Schema
- Example (from schema)
Schema
Server error code
A message describing the error code
{
"errorCode": 0,
"errorMessage": "string"
}
LogForwarding Service is not available