Retrieves data rule details by ID

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves the detailed summary of a specific data rule by its unique identifier.

Request URL

https://{server-hostname}:8383/endpointdlp/api/data-classification/data-rule/data-rule-details/{dataRuleId}

Scope

EndpointDLP.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/dataRuleDetail.v1+jsonapplication/dataRuleDetail.v1+jsonCopied!

- Path Parameters

dataRuleIdstringMandatory

Unique identifier of the data rule. Fetch from Get All Data Rules

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/endpointdlp/api/data-classification/data-rule/data-rule-details/{dataRuleId} \
  --header 'Accept: application/dataRuleDetail.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
dataRuleDetailJSON object

Data rule detail wrapper

Show Sub-Attributes
dataRuleNamestring

Name of the data rule

dataRuleIdstring

Unique identifier of the data rule

dataRuleTypeinteger

Type of the data rule (1=Predefined, 2=Custom)

dataRuleDescriptionstring

Description of the data rule

noOfOccurrencestring

Number of occurrences threshold

subRuleTypeIdinteger

Sub-rule type identifier (1=Regex, 2=Keyword, 3=Fingerprint)

regexSubRuleBeanJSON object

Regex sub-rule details (present when subRuleTypeId=1)

Show Sub-Attributes
regexValueListarray

List of regex patterns

dictionaryWordListarray

List of dictionary words

keywordSubRuleBeanJSON object

Keyword sub-rule details (present when subRuleTypeId=2)

Show Sub-Attributes
caseSensitiveboolean

Whether keyword matching is case-sensitive

fileDetailBeanJSON object

File details for the keyword reference file

Show Sub-Attributes
fileNamestring

Name of the reference file

fileLocationstring

Server-side path of the reference file

fingerprintSubRuleBeanJSON object

Fingerprint sub-rule details (present when subRuleTypeId=3)

Show Sub-Attributes
fileDetailBeanJSON object

File details for the fingerprint reference file

Show Sub-Attributes
fileNamestring

Name of the reference file

fileLocationstring

Server-side path of the reference file

extensionListarray

List of file extensions to scan

- HTTP code 500

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodestring

Internal error code returned when fetching data rule details by ID fails

errorMessagestring

Failure message describing why the data rule details could not be retrieved

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Successful retrieval of data rule details

Copied!
  {
    "dataRuleDetail": {
      "regexSubRuleBean": {
        "dictionaryWordList": [],
        "regexValueList": [
          "\\d{3}-\\d{2}-\\d{4}"
        ]
      },
      "keywordSubRuleBean": null,
      "dataRuleId": "1000045",
      "noOfOccurrence": "3",
      "dataRuleDescription": "Detects US Social Security Numbers",
      "extensionList": [
        "txt",
        "csv",
        "pdf"
      ],
      "dataRuleName": "US Social Security Number",
      "dataRuleType": 1,
      "fingerprintSubRuleBean": null,
      "subRuleTypeId": 1
    }
  }
                
Show full

Sample Response: HTTP 500

Internal server error

Copied!
  {
    "errorMessage": "Exception occurred while fetching DataRule summary",
    "errorCode": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.