Fetch compliance policy custom group details

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 details about a compliance policy custom group (target group) including name, status, creation info, schedule, and access permissions

Request URL

https://{serverurl}/dcapi/scap/compliance/map/CGDetails

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/map/CGDetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Custom group name

createdBystring

Creator first name

collectionIdlong

Collection ID for the association

cgCategorystring

Group category code (e.g., 2 = static, 7 = all computers)

viewAccessboolean

Whether user has view access

isSuspendedboolean

Whether the collection is suspended

isActionRestrictedboolean

Whether actions are restricted for this user

isTargetGroupAccessibleboolean

Whether user can access the target group

showModifiedBannerboolean

Whether to show the modified banner

schedulestring

Schedule type (e.g., Daily, Weekly)

nextRunTimestring

Next scheduled scan time

- 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 custom group details with schedule and access info

Copied!
  {
    "schedule": "Daily",
    "isSuspended": false,
    "nextRunTime": "2026-04-01 02:00:00",
    "isActionRestricted": false,
    "createdBy": "Admin",
    "showModifiedBanner": false,
    "name": "Production Servers",
    "isTargetGroupAccessible": true,
    "collectionId": 5001,
    "viewAccess": true,
    "cgCategory": 2
  }
                
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.