Fetch custom groups available for compliance audit association

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 a paginated list of static and static-unique custom groups available for compliance audit association. Supports filtering by group category and name

Request URL

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

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

isQuarantinebooleanOptional

To check if the API is called from Quarantine module

cgNamestringOptional

Custom group name filter for partial match

offsetlongOptional

Pagination offset

limitlongOptional

Pagination limit

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
customGroupsJSON Array

List of custom group objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idstring

Custom group resource ID

namestring

Custom group name

imagestring

Icon path based on group category

categorystring

Group category code

- 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

Paginated list of custom groups for compliance audit

Copied!
  {
    "customGroups": [
      {
        "image": "/images/static_group.png",
        "name": "Production Servers",
        "id": "301",
        "category": 2
      },
      {
        "image": "/images/all_computers.png",
        "name": "All Managed Computers",
        "id": "302",
        "category": 7
      }
    ]
  }
                
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.