Skip to main content

Update HTTPS profile

PUT 
/logging-service/logforwarding/v1/https-profiles/:profileId

Update an HTTPS profile using the etag obtained from retrieving the HTTPS profile by its profile ID. You can change only the destination and logtype fields. You can not change the profileType.

Request​

Path Parameters

    profileId stringrequired

    The ID of the profile you want to update.

Header Parameters

    etag string

    Tag required to update the profile.

Body

required

New profile value

    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​

Request successfully processed

Loading...