Fetch quarantine custom group summary statistics

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 summary statistics for a quarantine custom group including computer count, deployment status, notification settings, quarantine enforcement status, and creation/modification audit trail

Request URL

https://{serverurl}/dcapi/compliance/quarantine/policy/{grpResourceId}/summary

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

grpResourceIdstringMandatory

Custom group resource ID. Fetch from Get Quarantine Rule Details

- Query Parameters

groupResourceIdlongOptional

Custom group resource ID

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/compliance/quarantine/policy/{grpResourceId}/summary \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Custom group name

computerCountstring

Number of managed Windows computers in the group

createdBystring

Creator first name

createdTimestring

Formatted creation timestamp

lastModifiedBystring

Last modifier first name

lastModifiedTimestring

Formatted last modification timestamp

collectionIdlong

Collection ID for the quarantine policy

isSuspendedboolean

Whether the collection is suspended

currentStatusstring

I18N-translated deployment status label

enableNotificationstring

Yes if alert settings exist, No otherwise

isMachinesQuarantinedboolean

true if quarantine action is active quarantine, false if audit-only

isTargetGroupAccessibleboolean

Whether user can access the target group

enableCGRedirectionboolean

Whether UI should enable CG redirection links

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

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

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- 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
403HTTP code
429HTTP code

Sample Response: HTTP 200

Quarantine custom group summary statistics

Copied!
  {
    "lastModifiedTime": "Mar 28, 2026 02:30 PM",
    "isSuspended": false,
    "currentStatus": "Deployed",
    "lastModifiedBy": "Admin",
    "isTargetGroupAccessible": true,
    "computerCount": 15,
    "enableCGRedirection": true,
    "createdBy": "Admin",
    "name": "DMZ Servers",
    "createdTime": "Mar 15, 2026 10:00 AM",
    "enableNotification": "Yes",
    "isMachinesQuarantined": true,
    "collectionId": 6001
  }
                
Show full

Sample Response: HTTP 401

Authentication credentials are missing or invalid

Copied!
  {
    "errorMessage": "Authentication required",
    "errorCode": "UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 403

Quarantine is not available in VMP Professional Edition

Copied!
  {
    "errorMessage": "You do not have enough permission to perform this action. Upgrade to Enterprise Edition to use these features.",
    "errorCode": "FORBIDDEN"
  }
                
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.