Retrieves all predefined data rules

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 all predefined data rules.

Request URL

https://{serverurl}/endpointdlp/api/data-classification/data-rule/data-rules

Scope

DesktopCentralCloud.EndpointDLP.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/endpointdlp/api/data-classification/data-rule/data-rules \
  --header 'Accept: application/dataRules.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
dataRulesJSON Array

List of predefined data rules

Show Sub-Attributes
JSON Object
Show Sub-Attributes
ruleIdstring

Unique identifier of the data rule

ruleNamestring

Name of the data rule

subRuleTypeIdinteger

Sub-rule type identifier

dataCategoryIdstring

Associated data category identifier

countryIdstring

Associated country identifier

dataClassIdstring

Associated data class identifier

noOfOccurrencestring

Number of occurrences threshold

- HTTP code 500

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

Internal error code returned when fetching all data rules fails

errorMessagestring

Failure message describing why data rules could not be retrieved

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Successful retrieval of data rules

Copied!
  {
    "dataRules": [
      {
        "noOfOccurrence": "2",
        "ruleName": "Albania: International Bank Account Number",
        "dataCategoryId": "3",
        "ruleId": "1",
        "countryId": "1",
        "dataClassId": "1",
        "subRuleTypeId": 1
      },
      {
        "noOfOccurrence": "3",
        "ruleName": "American Express",
        "dataCategoryId": "2",
        "ruleId": "139",
        "countryId": "85",
        "dataClassId": "5",
        "subRuleTypeId": 1
      }
    ]
  }
                
Show full

Sample Response: HTTP 500

Internal server error

Copied!
  {
    "errorMessage": "Exception occurred while fetching DataRule :: <exception message>",
    "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.