Suspends an active configuration, temporarily halting deployment to targeted endpoints.
post /dcapi/configuration/{collectionId}/suspend
https://{serverurl}/dcapi/configuration/{collectionId}/suspend
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
The unique numeric identifier of the active configuration to be suspended. Fetch from Get Configurations View .
curl --request POST \
--url https://appdomains/dcapi/configuration/{collectionId}/suspend \
--header 'Accept: application/suspendCollnDetails.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Result of the suspend operation — Success or error message
The collection ID that was suspended
Display name of the suspended configuration
BAD_REQUEST: the collection is not in a deployable state (already suspended or trashed)
Message indicating the collection must be in deployed state to suspend
Unauthorized error code: credentials missing, expired, or invalid
Authentication failure reason
Configuration suspended successfully
{
"collectionId": 12345,
"status": "Success",
"collectionName": "Firewall_Policy_Win11"
}
Collection is not in a deployable state
{
"error_description": "Configuration is not in a deployable state",
"error_code": "BAD_REQUEST"
}
User lacks write role or scope
{
"error_description": "Access denied - You are not allowed to access the requested resource.",
"error_code": "UAC_UNAUTHORIZED"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.