Fetch compliance graph data aggregated across a custom 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 compliance graph data aggregated across all resources in a custom group, showing the overall compliance posture of the entire group

Request URL

https://{serverurl}/dcapi/scap/compliance/result/CGGraph

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

groupResourceIdlongOptional

Custom group resource ID

Sample Request

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

Response Parameters

- HTTP code 200

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

Overall scan status. SCAN_COMPLETED

statusJSON Object

Compliance status breakdown for the custom group

Show Sub-Attributes
attentionstring

Number of non-compliant resources

deployedstring

Number of resources scanned

percentagestring

Overall compliance percentage

breakdownJSON Object

Detailed resource compliance breakdown

Show Sub-Attributes
vulnerablestring

Resources with decreased compliance

decreasedCompliancestring

Resources where compliance decreased

increasedCompliancestring

Resources where compliance increased

securestring

Fully compliant resources

- 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

Custom group compliance graph data

Copied!
  {
    "scan": "SCAN_COMPLETED",
    "status": {
      "percentage": 80,
      "breakdown": {
        "vulnerable": 3,
        "decreasedCompliance": 2,
        "increasedCompliance": 8,
        "secure": 15
      },
      "attention": 5,
      "deployed": 25
    }
  }
                
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.