Trigger generation of a CIS compliance 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

Triggers asynchronous generation of a CIS compliance detailed report for the specified custom group, policy group, and profile with optional compliance status and percentage filters

Request URL

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

Scope

VulnerabilityMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/cisDetailedReport.v1+jsonapplication/cisDetailedReport.v1+jsonCopied!
AcceptstringMandatory
application/cisDetailedReport.v1+jsonapplication/cisDetailedReport.v1+jsonCopied!

- Request Body

application/json
JSON object
Hide Sub-Attributes
groupResourceIdlongOptional

Custom group resource ID to generate the report for. Fetch from Get CG Association Details

policyGrpIdlongOptional

Policy group ID to filter the report. Fetch from List Policy Groups

profileIdlongOptional

Profile ID to filter the report. Fetch from Get Profiles List for Platform or Get Profiles for Policy Group

compliancePercentagestringOptional

Compliance percentage filter. Use all for no filter

complianceStatusstringOptional

Compliance status filter. 0 = Passed, 1 = Failed, 3 = Error, 5 = Unscored. Supports comma-separated combinations (e.g., 1,3). Use all for no filter

reportNamestringOptional

Name for the generated report file

totalRowsCountlongOptional

Total rows count for validation against export limit. Fetch from Get CIS Report Row Count

exportTypestringOptional

Export format type

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/dcapi/scap/compliance/export/cisDetailedReport \
  --header 'Accept: application/cisDetailedReport.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/cisDetailedReport.v1+json' \
  --data '{"reportName":"CIS_Report_Production_2026","totalRowsCount":"15000","compliancePercentage":"all","profileId":"50001","complianceStatus":"all","groupResourceId":"301","policyGrpId":"1001"}'
Show full

Sample Request Body

Generate a CIS compliance detailed report with filters

Copied!
  {
    "reportName": "CIS_Report_Production_2026",
    "totalRowsCount": "15000",
    "compliancePercentage": "all",
    "profileId": "50001",
    "complianceStatus": "all",
    "groupResourceId": "301",
    "policyGrpId": "1001"
  }
                
Show full

Response Parameters

- HTTP code 200

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

true if the report generation was successfully initiated

messagestring

Status message when export is already in progress

- HTTP code 400

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

Bad request error code indicating required parameters are missing or invalid

errorMessagestring

Message indicating which parameters are missing from the request

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

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

Precondition failed error code. Total rows exceed the maximum export limit of 3000000

errorMessagestring

Message indicating the row count exceeds the maximum allowed limit for export

- 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
400HTTP code
401HTTP code
412HTTP code
429HTTP code

Sample Response: HTTP 200

Report generation initiated successfully

Copied!
  {
    "isExportInitiated": true
  }
                
Show full

Report generation is already running

Copied!
  {
    "message": "Export in progress. Please re-initiate once the current report has been successfully exported.",
    "isExportInitiated": false
  }
                
Show full

Sample Response: HTTP 400

Required parameters are missing or invalid

Copied!
  {
    "errorMessage": "Required parameters are missing from the request",
    "errorCode": "INSUFFICIENT_DATA"
  }
                
Show full

A request body parameter has an invalid format or type

Copied!
  {
    "errorCode": "IAM0025",
    "errorMsg": "groupResourceId is an invalid parameter format."
  }
                
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 412

Total rows exceed the maximum export limit

Copied!
  {
    "errorMessage": "The total row count exceeds the supported limit, so exporting this report is not possible. Please retry with a different configuration.",
    "errorCode": "INTERNAL_ERROR"
  }
                
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.