Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
dataDeletionRules

Create a new Data Deletion Rule

Create a new data deletion rule to delete logs.

post/v1/dataDeletionRules

Request body

ruleNamestring required

Name of the deletion rule.

ruleReasonstring required

Reason mentioning what data is being deleted and why.

querystring required

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

startMillisinteger required

Start time of the search as a number of milliseconds.

endMillisinteger required

End time of the search as a number of milliseconds.

byReceiptTimeboolean

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.

timezonestring

Timezone for the resolving timerange from startMillis,endMillis

parsingModestring

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.

Example request

{
  "startMillis": 1704976268773,
  "endMillis": 1704977168773,
  "parsingMode": "AutoParse"
}

Response

The data deletion Rule that has been created

ruleNamestring required

Name of the deletion rule.

ruleReasonstring required

Reason mentioning what data is being deleted and why.

querystring required

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

startMillisinteger required

Start time of the search as a number of milliseconds.

endMillisinteger required

End time of the search as a number of milliseconds.

byReceiptTimeboolean

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.

timezonestring

Timezone for the resolving timerange from startMillis,endMillis

parsingModestring

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

Identifier for the deletion rule.

createdAtstring date-time

Creation timestamp in UTC.

modifiedAtstring date-time

Last modification timestamp in UTC in RFC3339 format.

errorstring

Errors related to the deletion rule.

statusstring

Status of the deletion rule.

createdBystring

Identifier of the user who created the deletion rule.

modifiedBystring

Identifier of the user who last modified the resource.

Example response

{
  "startMillis": 1704976268773,
  "endMillis": 1704977168773,
  "parsingMode": "AutoParse",
  "createdBy": "0000000006743FE8",
  "modifiedBy": "0000000006743FE8"
}