POST /v1/dataDeletionRules

Create a new data deletion rule to delete logs.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
timezone String No

Timezone for the resolving timerange from startMillis,endMillis

Default value: "UTC"

ruleName String Yes

Name of the deletion rule.

query String Yes

query to filter out the logs that need to be deleted.

startMillis Integer Yes

Start time of the search as a number of milliseconds.

endMillis Integer Yes

End time of the search as a number of milliseconds.

ruleReason String Yes

Reason mentioning what data is being deleted and why.

byReceiptTime Boolean No

Flag to order the search results in the order collector received it. This has the value true if the search is to be run by receipt time and false if it is to be run by message time.

Default value: false

parsingMode String No

Define the parsing mode to scan the JSON format log messages. Possible values are:

  1. AutoParse
  2. Manual In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see Dynamic Parsing.

Default value: "Manual"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.