Fetch quarantine policy configuration for a custom group

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 the complete quarantine policy configuration including rules, restrictions, warning and grace period settings, and notification preferences for the specified custom group

Request URL

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

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

grpResourceIdstringMandatory

The resource ID of the quarantine custom group to delete. Fetch from Get Quarantine Rule Details

- Query Parameters

excludeTargetsbooleanOptional

If true, returns only rules and restrictions without target group details

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
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
Hide Sub-Attributes
customGrouplong

Custom group resource ID

collectionIdlong

Associated quarantine collection ID

cgNamestring

Custom group name

statusstring

Collection deployment status

quarantineRulesarray

List of configured quarantine rules including patch severity, software, service, vulnerability, registry, and file checks

quarantineRestrictionsJSON Object

Action type and network restriction configuration for quarantine enforcement

Show Sub-Attributes
enableWarnUserboolean

Whether user warning dialog is enabled

warningTitlestring

Warning dialog title text

warningDescstring

Warning dialog description text

enableGracePeriodboolean

Whether grace period is configured before enforcement

graceTitlestring

Grace period notification title

graceDescstring

Grace period notification description

gracePeriodstring

Grace period duration in days

graceNotificationTimestring

Time for grace notification in HH:mm format

ENABLE_EMAIL_NOTIFYboolean

Whether email notifications are enabled

EMAIL_DURATIONstring

Email notification duration

EMAIL_ENABLED_DAYSstring

Comma-separated days when email notifications are active

EMAILstring

Notification email address

ENABLE_MOBILE_NOTIFY_FOR_USERSarray

List of users enabled for mobile notifications

- 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

Full quarantine policy configuration with target group details

Copied!
  {
    "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"
  }
                
Show full

Quarantine rules and restrictions only (excludeTargets=true)

Copied!
  {
    "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"
  }
                
Show full

Sample Response: HTTP 401

User lacks scope access to the custom group

Copied!
  {
    "errorMessage": "User Not Authorized",
    "errorCode": "UAC_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.