# Fetch quarantine policy configuration for a custom group Retrieves the complete quarantine policy configuration including rules, restrictions, warning and grace period settings, and notification preferences for the specified custom group. ## Endpoints `GET /dcapi/compliance/quarantine/policy/{grpResourceId}` ## Request URL `https://{serverurl}/dcapi/compliance/quarantine/policy/{grpResourceId}` ## Scope `DesktopCentralCloud.VulnerabilityMgmt.READ` ## Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Path Parameters - **grpResourceId** (`string`, Mandatory): The resource ID of the quarantine custom group to delete. Fetch from [Get Quarantine Rule Details](https://www.manageengine.com/products/desktop-central/help/api/cloud/get-quarantine-rule-details.html). ### Query Parameters - **excludeTargets** (`boolean`, Optional): If true, returns only rules and restrictions without target group details. ## Sample Request ```bash curl --request GET \ --url https://appdomains/dcapi/compliance/quarantine/policy/{grpResourceId} \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 *Response Body: `application/json`* `JSON Object` - **customGroup** (`long`): Custom group resource ID. - **collectionId** (`long`): Associated quarantine collection ID. - **cgName** (`string`): Custom group name. - **status** (`string`): Collection deployment status. - **quarantineRules** (`array`): List of configured quarantine rules including patch severity, software, service, vulnerability, registry, and file checks. - **quarantineRestrictions** (`JSON Object`): Action type and network restriction configuration for quarantine enforcement. - **enableWarnUser** (`boolean`): Whether user warning dialog is enabled. - **warningTitle** (`string`): Warning dialog title text. - **warningDesc** (`string`): Warning dialog description text. - **enableGracePeriod** (`boolean`): Whether grace period is configured before enforcement. - **graceTitle** (`string`): Grace period notification title. - **graceDesc** (`string`): Grace period notification description. - **gracePeriod** (`string`): Grace period duration in days. - **graceNotificationTime** (`string`): Time for grace notification in `HH:mm` format. - **ENABLE_EMAIL_NOTIFY** (`boolean`): Whether email notifications are enabled. - **EMAIL_DURATION** (`string`): Email notification duration. - **EMAIL_ENABLED_DAYS** (`string`): Comma-separated days when email notifications are active. - **EMAIL** (`string`): Notification email address. - **ENABLE_MOBILE_NOTIFY_FOR_USERS** (`array`): List of users enabled for mobile notifications. ### HTTP Code 401 *Response Body: `application/json`* `JSON Object` - **errorCode** (`long`): Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required). - **errorMsg** (`string`): Authentication failure reason. ### HTTP Code 403 *Response Body: `application/json`* `JSON Object` - **errorCode** (`long`): Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin). - **errorMsg** (`string`): Message indicating insufficient privileges to access this resource. ### HTTP Code 429 *Response Body: `application/json`* `JSON Object` - **errorCode** (`long`): 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. - **errorMsg** (`string`): Rate limit exceeded message with retry guidance. ## Possible Response Codes - **200**: HTTP code. - **401**: HTTP code. - **403**: HTTP code. - **429**: HTTP code. ## Sample Responses ### HTTP 200 Full quarantine policy configuration with target group details: ```json { "quarantineRestrictions": { "quarantineAction": "2", "blockAction": "2", "allowRestrictAccess": [ { "condition": "domain", "value": "*.company.com" } ] }, "warningDesc": "Your system will be quarantined.", "gracePeriod": "7", "graceDesc": "Resolve issues within the grace period.", "quarantineRules": [ { "condition": "osPatch", "interval": "30", "severities": [ "critical", "important" ] }, { "condition": "software", "softwareName": "TeamViewer", "status": "installed" }, { "condition": "vulnerability", "operation": "cvss", "value": "7.0" } ], "warningTitle": "Non-Compliant System", "EMAIL_DURATION": "1", "graceTitle": "Grace Period", "EMAIL": "security@company.com", "ENABLE_MOBILE_NOTIFY_FOR_USERS": [ "admin1" ], "enableGracePeriod": true, "cgName": "DMZ Servers", "enableWarnUser": true, "ENABLE_EMAIL_NOTIFY": true, "customGroup": 301, "EMAIL_ENABLED_DAYS": "1,2,3,4,5", "graceNotificationTime": "10:00", "collectionId": 6001, "status": "Deployed" } ``` Quarantine rules and restrictions only (`excludeTargets=true`): ```json { "quarantineRestrictions": { "quarantineAction": "1" }, "quarantineRules": [ { "condition": "osPatch", "interval": "30", "severities": [ "critical" ] } ], "ENABLE_EMAIL_NOTIFY": false, "EMAIL_DURATION": "", "EMAIL_ENABLED_DAYS": "", "EMAIL": "", "ENABLE_MOBILE_NOTIFY_FOR_USERS": [], "status": "Deployed" } ``` ### HTTP 401 User lacks scope access to the custom group: ```json { "errorMessage": "User Not Authorized", "errorCode": "UAC_UNAUTHORIZED" } ``` ### HTTP 403 Quarantine is not available in VMP Professional Edition: ```json { "errorMessage": "You do not have enough permission to perform this action. Upgrade to Enterprise Edition to use these features.", "errorCode": "FORBIDDEN" } ``` ### HTTP 429 API call threshold exceeded: ```json { "errorMessage": "Rate limit exceeded. Retry after some time", "errorCode": "TOO_MANY_REQUESTS" } ``` ## Rate Limits ![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.