Fetch the list of all CIS compliance policy groups

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 custom CIS compliance policy groups for the given customer, including policy group ID, name, type, platform, and icon details

Request URL

https://{serverurl}/dcapi/scap/compliance/policygroups

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/scap/compliance/policygroups \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Unique identifier of the policy group

policyGrpTypestring

Policy group type. 0 = default (CRS), 1 = custom

policyGrpNamestring

Name of the policy group

platformstring

Platform identifier. 1 = Windows, 3 = Linux

imagestring

Platform icon image path

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

Possible Response Codes

200HTTP code
401HTTP code
429HTTP code

Sample Response: HTTP 200

List of all custom CIS compliance policy groups

Copied!
  [
    {
      "image": "/images/windows.png",
      "policyGrpType": 1,
      "policyGrpName": "Windows CIS L1 Policy",
      "platform": 1,
      "policyGrpId": 1001
    },
    {
      "image": "/images/linux_icon.png",
      "policyGrpType": 0,
      "policyGrpName": "Linux CIS L2 Policy",
      "platform": 3,
      "policyGrpId": 1002
    }
  ]
                
Show full

Sample Response: HTTP 401

Authentication credentials are missing or invalid

Copied!
  {
    "errorMessage": "Authentication required",
    "errorCode": "UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorMessage": "Rate limit exceeded. Retry after some time",
    "errorCode": "TOO_MANY_REQUESTS"
  }
                
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.