Skip to main content

Create an HTTPS profile

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

Create an HTTPS profile object to send logs to an HTTPS receiver or SIEM.

Request​

Body

required
    destination objectrequired

    Profile name and HTTPS receiver information.

    clientAuth object
    oneOf
    primaryKey stringrequired

    Your Microsoft Sentinel workspace primary key.

    workspaceId stringrequired

    Your Microsoft Sentinel workspace ID.

    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

    The parameters used to specify the logs that you want to send.

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

  • ]

Responses​

Returns profile id on successful request processing

Schema

    string

Loading...