Get syslog profile

GET 
/logging-service/logforwarding/v1/syslog-profiles/:profileId

Retrieve the syslog profile that has the specified profile ID. The response header contains the etag that you need to update the syslog profile.

Request

Path Parameters

profileId stringrequired

The ID of the profile you want to retrieve.

Responses

200

Request successfully processed

Response Headers

• etag string

  Tag for controlling concurrent updates

application/json

Schema

Schema

destination objectrequired

Profile name, output, and syslog receiver information.

displayName stringrequired

Name of the profile.

facility stringrequired

Syslog facility value as per IETF standards.

notification string

An email address to receive updates about log transmission.

outputDelimiter stringrequired

Character that separates log fields. Based on log format.

outputFormat stringrequired

Possible values: [CSV, LEEF, CEF]

The format in which to send logs.

port integerrequired

Possible values: <= 65535

The port on which to send logs.

profileToken string

A token used to uniquely identify your logs to a cloud-based syslog service.

server stringrequired

IP address or FQDN of your syslog server.

logtypes object[]required
Array [
allColumns boolean
True sends all log fields. False sends a subset of log fields.
excludedColumns string[]
The specific log fields you do not want to send. Does nothing if the same field is present in includedColumns.
filter string
The filter query used to send a subset of logs.
includedColumns string[]
The specific log fields you want to send. Does nothing if allColumns is True.
logtype string
The log type that you want to send.
]
profileId stringrequired
status ProfileStatus (string)required

Possible values: [pending, inactive, active]

Profile status

Example (from schema)

{
  "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"
}

404

Profile ID does not exists

application/json

Schema

Schema

errorCode integer

Server error code

errorMessage stringrequired

A message describing the error code

Example (from schema)

{
  "errorCode": 0,
  "errorMessage": "string"
}

429

Too many request

500

LogForwarding Service internal error

application/json

Schema

Schema

errorCode integer

Server error code

errorMessage stringrequired

A message describing the error code

Example (from schema)

{
  "errorCode": 0,
  "errorMessage": "string"
}

503

LogForwarding Service is not available

Loading...