Fetch compliance graph data for a specific resource

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 for a specific resource within a custom group, showing the overall compliance percentage and breakdown of all profiles scanned

Request URL

https://{server-hostname}:8383/dcapi/scap/compliance/result/resourceGraph/{resourceId}

Scope

VulnerabilityMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

resourceIdstringMandatory

Computer/resource ID. Fetch from Get CG Association Details

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/scap/compliance/result/resourceGraph/{resourceId} \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

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

Scan status. SCAN_SCHEDULED, SCAN_FAILED, SCAN_SUCCEEDED, or YET_TO_SCAN

statusJSON object

Compliance status breakdown for the resource

Show Sub-Attributes
totalRulesstring

Total rules across all profiles for the resource

scannedstring

Number of scanned profiles

attentionstring

Number of failed rules

percentagestring

Overall pass percentage or NA

breakdownJSON object

Detailed rule breakdown

Show Sub-Attributes
passedstring

Total passed rules

failedstring

Total failed rules

unscoredstring

Total unscored rules

errorstring

Total error rules

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

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 threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

Possible Response Codes

200HTTP code
401HTTP code
429HTTP code

Sample Response: HTTP 200

Resource compliance graph data after successful scan

Copied!
  {
    "scan": "SCAN_SUCCEEDED",
    "status": {
      "scanned": 2,
      "percentage": "82",
      "breakdown": {
        "unscored": 35,
        "passed": 400,
        "failed": 45,
        "error": 10
      },
      "attention": 45,
      "totalRules": 490
    }
  }
                
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.