Get HTTPS profile
GET/logging-service/logforwarding/v1/https-profiles/:profileId
Retrieve the HTTPS profile that has the specified profile ID. The response header contains the etag that you need to update the HTTPS profile.
Request
Path Parameters
The ID of the profile you want to retrieve.
Responses
- 200
- 404
- 429
- 500
- 503
Request successfully processed
Response Headers
etag string
Tag for controlling concurrent updates
- application/json
- Schema
- Example (from schema)
Schema
- ClientAuthSentinel
- ClientAuthChronicle
- ClientAuthSplunk
- ClientAuthBasic
- Array [
- ]
destination objectrequired
Profile name and HTTPS receiver information.
clientAuth object
Your Microsoft Sentinel workspace primary key.
Your Microsoft Sentinel workspace ID.
Your Google Workspace Customer ID.
Your Google Workspace Service Account Token. Must be stringified.
Your Splunk HTTP Event Collector Token
HTTPS server password.
HTTPS server user name.
Possible values: [Splunk
, Sentinel
, Chronicle
, Basic
, None
]
The type of HTTPS destination to receive your logs.
Name of the profile.
An email address to receive updates about log transmission.
Possible values: [ARRAY_JSON
, STACKED_JSON
]
The format of the log data. Select the correct format for your HTTPS receiver.
The URI for the HTTPS destination. Must begin with https:/
.
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"
}
Profile ID does not exists
- 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