Suspend an active configuration

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 configuration, temporarily halting deployment to targeted endpoints.

Request URL

https://{serverurl}/dcapi/configuration/{collectionId}/suspend

Scope

DesktopCentralCloud.Configurations.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/suspendCollnDetails.v1+jsonapplication/suspendCollnDetails.v1+jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique numeric identifier of the active configuration to be suspended. Fetch from Get Configurations View .

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/configuration/{collectionId}/suspend \
  --header 'Accept: application/suspendCollnDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Result of the suspend operation — Success or error message

collectionIdlong

The collection ID that was suspended

collectionNamestring

Display name of the suspended configuration

- HTTP code 400

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

BAD_REQUEST: the collection is not in a deployable state (already suspended or trashed)

error_descriptionstring

Message indicating the collection must be in deployed state to suspend

- 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

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code

Sample Response: HTTP 200

Configuration suspended successfully

Copied!
  {
    "collectionId": 12345,
    "status": "Success",
    "collectionName": "Firewall_Policy_Win11"
  }
                
Show full

Sample Response: HTTP 400

Collection is not in a deployable state

Copied!
  {
    "error_description": "Configuration is not in a deployable state",
    "error_code": "BAD_REQUEST"
  }
                
Show full

Sample Response: HTTP 401

User lacks write role or scope

Copied!
  {
    "error_description": "Access denied - You are not allowed to access the requested resource.",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
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.