Restore a previously trashed 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

Restores a configuration from the trash back to active state.

Request URL

https://{serverurl}/dcapi/configuration/trash/restore

Scope

DesktopCentralCloud.Configurations.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

collectionIdlongOptional

The unique ID of the trashed configuration to restore.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/configuration/trash/restore \
  --header 'Accept: application/restoreTrashConfigStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Localised message containing the restored collection name and success confirmation

- HTTP code 400

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

SERVICE_NOT_AVAILABLE: the configuration has been deprecated and cannot be restored

error_descriptionstring

Message indicating the deprecated configuration cannot be restored

- 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 413

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

INTERNAL_SERVER_ERROR: insufficient storage space to restore the configuration files

error_descriptionstring

Message indicating insufficient disk space to restore the configuration

- HTTP code 500

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

CONFIG_INTERNAL_ERROR: unexpected failure during the restore operation

error_descriptionstring

Message describing the unexpected server error during restore

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
413HTTP code
500HTTP code

Sample Response: HTTP 200

Configuration restored successfully from trash

Copied!
  {
    "status": "'Firewall_Policy_Win11' has been restored successfully."
  }
                
Show full

Sample Response: HTTP 400

Configuration has been deprecated and cannot be restored

Copied!
  {
    "error_description": "Configuration has been deprecated and cannot be restored",
    "error_code": "SERVICE_NOT_AVAILABLE"
  }
                
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

Sample Response: HTTP 413

Insufficient storage space to restore

Copied!
  {
    "error_description": "Insufficient storage space to restore the configuration",
    "error_code": "INTERNAL_SERVER_ERROR"
  }
                
Show full

Sample Response: HTTP 500

Unexpected failure during restore

Copied!
  {
    "error_description": "Unexpected failure during the restore operation",
    "error_code": "CONFIG_INTERNAL_ERROR"
  }
                
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.