Get rule-level compliance summary for a profile

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

Returns a rule-by-rule compliance summary for the specified compliance profile, with device counts and criticality per rule.

Request URL

https://{serverurl}/bsp/api/v1/bmp/compliance/{compliance_id}/rules/summary

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

compliance_idstringMandatory

Compliance profile ID from List Compliance Profiles response (profileid field)

- Query Parameters

browser_idlongOptional

Optional. Values: 1=Chrome, 2=Firefox, 3=IE, 5=Edge, 31=Ulaa, 1024=Chromium

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/compliance/{compliance_id}/rules/summary \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Per-rule compliance status across devices

Show Sub-Attributes
JSON Object
Show Sub-Attributes
rule_idlong

Unique identifier of the compliance rule

compliant_devicesstring

Count of devices compliant with this rule

non_compliant_devicesstring

Count of devices noncompliant with this rule

criticalitystring

Rule criticality level. 1=Low, 2=Medium, 3=High

category_detailsJSON Array

Category groupings with associated rule IDs

Show Sub-Attributes
JSON Object
Show Sub-Attributes
rule_namestring

Category group name (e.g., Threat Prevention, Data Leakage Prevention)

rulesarray

Rule IDs belonging to this category group

- HTTP code 400

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

Error code indicating the browser_id query parameter has an invalid format

errorMsgstring

Message specifying which parameter has an invalid format

urlstring

Request URL that triggered the error

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

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

Message describing the server-side failure

error_codestring

Internal server error code

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Rules summary

Copied!
  {
    "category_details": [
      {
        "rule_name": "Threat Prevention",
        "rules": [
          1
        ]
      },
      {
        "rule_name": "Data Leakage Prevention",
        "rules": [
          2
        ]
      }
    ],
    "rule_status": [
      {
        "rule_id": 1,
        "compliant_devices": 145,
        "non_compliant_devices": 12,
        "criticality": 2
      },
      {
        "rule_id": 2,
        "compliant_devices": 130,
        "non_compliant_devices": 27,
        "criticality": 3
      }
    ]
  }
                
Show full

Profile not found

Copied!
  {}
                
Show full

Sample Response: HTTP 400

Invalid browser_id

Copied!
  {
    "errorCode": "IAM0025",
    "url": "/bsp/api/v1/bmp/compliance/{compliance_id}/rules/summary",
    "errorMsg": "browser_id is an invalid parameter format."
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
Show full

Duration: 1 minute | Threshold: 60 | 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.