Get email profile

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

Retrieve the email profile that has the specified profile ID. The response header contains the etag that you need to update the email 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 and email recipient information.

bcc string[]

Additional addresses to receive the emails. Max of 10.

displayName stringrequired

Name of the profile.

subject stringrequired

Subject to appear in the emails.

to stringrequired

Email address of the recipient.

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

ID of the profile.

status ProfileStatus (string)required

Possible values: [pending, inactive, active]

Profile status

Example (from schema)

{
  "destination": {
    "bcc": [
      "jbendonis@techniumnetworking.com",
      "khanm@wavelifesci.com"
    ],
    "displayName": "PA-Disable-Client",
    "subject": "Global Protect Disable - Notification",
    "to": "paloaltoreporting@wavelifesci.com"
  },
  "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 does not exist

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 requests

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...