List Data Patterns

PUT 
/dlp/api/v1/dss-api/data-pattern

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Lists all data patterns that satisfy the request filters.

Request

application/json; charset=UTF-8

Body

modeFilter string[]

Mode filter list

timeRange object

See the Time Range Model for details.

oneOf

RelativeTimeRangeConfigModel

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

AbsoluteTimeRangeConfigModel

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

ToNowTimeRangeConfigModel

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

type stringrequired

Possible values: [absolute, relative, to_now]

Time type

absolute

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

relative

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

to_now

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

updatedByFilter string[]

Updated By list

Responses

200

success

application/json; charset=UTF-8

Schema

Schema

lastUpdatedByFilter string[]

Last Updated By Filter

modeFilter string[]

Mode Filter

patterns object[]
Pattern List
Array [
confidenceLevels string[]required
List of confidence levels
createdBy string
Created By
delimiter string
Delimiter to separate the regex and weight in UI
description stringrequired
Pattern Description
detectionTechnique stringrequired
Detection technique
entity string
Entity
grammar string
Grammar
id stringrequired
Pattern id
isEditable boolean
Is Editable
mode string
Mode (custom/predefined)
name stringrequired
Pattern Name
parentId string
Parent ID
proximityKeywords string[]required
List of Proximity Keywords
regexes object[]required
List of regexes
Array [
regex string
Regex
weight int32
Weight
]
rootType string
Root Type
s3Path string
S3 Path to the grammar
status stringrequired
Pattern status
updatedAt int64
Last updated At
updatedBy string
Updated By
]

Example (from schema)

{
  "lastUpdatedByFilter": [
    "string"
  ],
  "modeFilter": [
    "string"
  ],
  "patterns": [
    {
      "confidenceLevels": [
        "string"
      ],
      "createdBy": "string",
      "delimiter": "string",
      "description": "string",
      "detectionTechnique": "string",
      "entity": "string",
      "grammar": "string",
      "id": "string",
      "isEditable": true,
      "mode": "string",
      "name": "string",
      "parentId": "string",
      "proximityKeywords": [
        "string"
      ],
      "regexes": [
        {
          "regex": "string",
          "weight": 0
        }
      ],
      "rootType": "string",
      "s3Path": "string",
      "status": "string",
      "updatedAt": 0,
      "updatedBy": "string"
    }
  ]
}

400

bad_request

application/json; charset=UTF-8

Schema

Schema

detail string

Exception details

message string

API response

name string

Exception name

Example (from schema)

{
  "detail": "string",
  "message": "string",
  "name": "string"
}

Loading...