Fetch the profiles associated with a policy group

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 policy group name and its associated CIS benchmark profiles for the specified policy group ID

Request URL

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

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

policyGrpIdstringMandatory

The ID of the policy group. Fetch from List Policy Groups

Sample Request

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

Response Parameters

- HTTP code 200

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

Name of the policy group

profilesJSON Array

List of associated CIS benchmark profiles

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idlong

Profile ID. Fetch from Get Profiles List for Platform

typelong

Profile type. 1 = XCCDF. Fetch from Get Profiles List for Platform

- 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

Policy group with associated CIS benchmark profiles

Copied!
  {
    "profiles": [
      {
        "id": 50001,
        "type": 1
      },
      {
        "id": 50002,
        "type": 1
      }
    ],
    "grpName": "Windows CIS Level 1 Policy"
  }
                
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.