Suspend an active quarantine compliance collection

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

Suspends an active quarantine compliance collection, pausing policy enforcement until resumed

Request URL

https://{serverurl}/dcapi/compliance/quarantine/policy/{collectionId}/suspend

Scope

DesktopCentralCloud.VulnerabilityMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

collectionIdstringMandatory

The quarantine collection ID to suspend. Fetch from Get Quarantine Rule Details

Sample Request

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

Response Parameters

- HTTP code 200

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

Operation result. Success for suspend, Resumed or Expired for resume

collectionNamestring

Name of the compliance collection

- HTTP code 401

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

Unauthorized error code. Collection is not a compliance or quarantine collection, or user lacks scope access

errorMessagestring

Message indicating the collection type mismatch or insufficient scope

- 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

Quarantine collection suspended successfully

Copied!
  {
    "STATUS": "Success",
    "collectionName": "DMZ Quarantine Policy"
  }
                
Show full

Sample Response: HTTP 401

The provided collection is not a quarantine collection or user lacks scope

Copied!
  {
    "errorMessage": "The given Collection is not a Quarantine Collection",
    "errorCode": "UAC_UNAUTHORIZED"
  }
                
Show full

User does not have scope access to the resource group

Copied!
  {
    "errorMessage": "No access, Provided resource group is not in scope",
    "errorCode": "UAC_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.