Get all HTTPS profiles

GET 
/logging-service/logforwarding/v1/https-profiles

Retrieve information about all existing HTTPS profiles, including their profile IDs.

Request

Query Parameters

status ProfileStatus[]

Possible values: [pending, inactive, active]

The status of the profiles to be returned.

resultSize integer

Default value: 100

The maximum number of profiles to be returned.

Responses

200

Request successfully processed

application/json

Schema

Schema

• Array [
destination objectrequired

Profile name and HTTPS receiver information.

clientAuth object

oneOf

ClientAuthSentinel

primaryKey stringrequired

Your Microsoft Sentinel workspace primary key.

workspaceId stringrequired

Your Microsoft Sentinel workspace ID.

ClientAuthChronicle

customerId stringrequired

Your Google Workspace Customer ID.

serviceAccount stringrequired

Your Google Workspace Service Account Token. Must be stringified.

ClientAuthSplunk

hecToken stringrequired

Your Splunk HTTP Event Collector Token

ClientAuthBasic

password stringrequired

HTTPS server password.

username stringrequired

HTTPS server user name.

clientAuthType stringrequired

Possible values: [Splunk, Sentinel, Chronicle, Basic, None]

The type of HTTPS destination to receive your logs.

displayName stringrequired

Name of the profile.

notification string

An email address to receive updates about log transmission.

payloadFormat stringrequired

Possible values: [ARRAY_JSON, STACKED_JSON]

The format of the log data. Select the correct format for your HTTPS receiver.

profileToken string

uri stringrequired

The URI for the HTTPS destination. Must begin with https:/.

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

400

Invalid input

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