Fetch the total row count for a CIS detailed report

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 the total row count and export eligibility for a CIS detailed report with the specified filters. Export is allowed only if the row count is within the maximum limit

Request URL

https://{server-hostname}:8383/dcapi/scap/compliance/export/rowCount

Scope

VulnerabilityMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/scap/compliance/export/rowCount \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

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

Total number of rows matching the specified filters

isExportAllowedboolean

Whether export is permitted based on the row count limit

messagestring

Reason message when export is not allowed

- 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

Row count is within the export limit

Copied!
  {
    "totalRows": 15000,
    "isExportAllowed": true
  }
                
Show full

Row count exceeds the maximum export limit

Copied!
  {
    "totalRows": 4000000,
    "message": "The total row count exceeds the supported limit, so exporting this report is not possible. Please retry with a different configuration.",
    "isExportAllowed": false
  }
                
Show full

No matching results found for the filters

Copied!
  {
    "totalRows": 0,
    "message": "No results were found for the selected criteria",
    "isExportAllowed": false
  }
                
Show full

Sample Response: HTTP 401

Compliance report is not available for this edition

Copied!
  {
    "errorMessage": "Authentication required",
    "errorCode": "UAC_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: 250 | 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.