Create a reusable Folder Backup template for Windows endpoints.

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

Creates a Folder Backup template to back up source folders to a destination on Windows target endpoints. This policy supports only computer configurations.

Request URL

https://{serverurl}/dcapi/config-policies/v2/windows/folderBackup Copied!

Scope

DesktopCentralCloud.Configurations.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

Media type of the request body, as consumed by the endpoint.

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Media type of the response body, as produced by the endpoint.

- Request Body

application/json
JSON Object
Hide Sub-Attributes
labelstringMandatory

Name of the configuration. Returned as templateName in the response.

descriptionstringOptional

Free-text description of the configuration. May be an empty string.

configTypestringMandatory

What the configuration is applied to. Must be computer - Folder Backup applies to computers only.

applyAlwaysbooleanOptional

Reapply the configuration at every agent refresh, even when it has already been applied successfully.

applyAtStartupLogonbooleanOptional

Apply the configuration at endpoint startup.

applyAtRefreshbooleanOptional

Apply the configuration at the scheduled agent refresh.

enableRetrybooleanOptional

Retry the configuration on the endpoint when it fails. noOfRetries sets how many attempts are made.

enableRefreshMinRetrybooleanOptional

Honour refreshMinRetry as the minimum gap between two retries at refresh.

enableLogonStartupMinRetrybooleanOptional

Honour logonStartupMinRetry as the minimum gap between two retries at startup or logon.

noOfRetriesintegerOptional

Number of retry attempts made after a failure. Read only when enableRetry is true.

refreshMinRetryintegerOptional

Minimum number of minutes between two retries at refresh. Read only when enableRefreshMinRetry is true.

logonStartupMinRetryintegerOptional

Minimum number of minutes between two retries at startup or logon. Read only when enableLogonStartupMinRetry is true.

configDetailsJSON ArrayMandatory

One entry per source folder to back up, applied in the order they appear. Folder Backup supports only computer configurations.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
sourceFolderstringMandatory

Endpoint folder whose contents are backed up. Mandatory.
Example: sourceFolder: "C:\Users\Public\Documents".

destinationFolderstringMandatory

Destination folder where the contents of the source folder should be backed up.
Example: destinationFolder: "\BackupServer\Backups\UserData".

credentialDetailsJSON ObjectOptional

Saved credential used to reach the destination location, referenced by credentialID and credentialUUID from List Credentials. Always use an actual saved credential and avoid using credentialDetails: {credentialID: "-1", credentialName: "", credentialUUID: "--"}.

Show Sub-Attributes
credentialIDlongOptional

Identifier of a credential already saved under Admin - Credential Manager. Fetch it from List Credentials. Pass the credentialID together with its credentialUUID; the credential secret itself is never sent through this API.

credentialUUIDstringOptional

UUID of the saved credential, used to reference it without transmitting the secret. Fetch it from List Credentials. Must correspond to the credentialID supplied alongside it.

credentialNamestringOptional

Display name of the saved credential.

includeHiddenFilebooleanOptional

Whether hidden files should be included in the backup.
Allowed Values:
true = Includes hidden files in the backup.
false = Excludes hidden files from the backup. Default: true

includeSubFolderbooleanOptional

Whether subfolders within the source folder should be included in the backup.
Allowed values:
true = Include subfolders within the source folder in the backup.
false = Exclude subfolders from the backup.

maxFileSizeJSON ObjectMandatory

Maximum file size that can be included in the backup. Mandatory. Files exceeding the specified size will be excluded.

Show Sub-Attributes
valuestringMandatory

Maximum file size value. Mandatory.
Example: value: "100".

unitstringMandatory

Unit used for the maximum file size, such as mb or gb. Mandatory.
Example: unit: "mb".

excludeFilesAndFoldersarray[string]Optional

Files or folders that should be excluded from the backup.
Supported file formats: *.txt, *.tmp, New Folder*

enableEmailNotifybooleanOptional

Send an email to the addresses listed in email once the deployment finishes.

enableNotificationbooleanOptional

Notify the endpoint user about this deployment. notificationDuration and notificationEnabledDays are read only when this is true.

emailstringOptional

Comma-separated email addresses notified about the deployment. May be an empty string when enableEmailNotify is false.

notificationDurationintegerOptional

How long a deployment notification stays on screen for the endpoint user. Read only when enableNotification is true.

notificationEnabledDaysintegerOptional

Number of days for which deployment notifications stay enabled. Read only when enableNotification is true.

Examples

Back Up Folder▼
Back Up Folder -- Back up a folder to a destination with exclusions and size controls.
Back Up Multiple Folders -- Back up multiple source folders to the same destination in a single template.
Back Up Folder Using Credentials -- Back up a folder to a shared network destination using configured credentials.
Back Up Folder Including Hidden Files -- Back up a folder including hidden files and folders.
Back Up Folder Including Subfolders -- Back up a folder and include its subfolders and their contents.
Back Up Folder with File Size Limit -- Back up a folder while excluding files that exceed the configured maximum file size.
Back Up Folder with File Exclusions -- Back up a folder while excluding specified files and folders based on names or patterns.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\BackupServer\\Backups\\UserData","sourceFolder":"C:\\Users\\Public\\Documents","maxFileSize":{"unit":"mb","value":"100"}}],"label":"Folder Backup Config","configType":"computer"}'

Sample Request Body - Back Up Folder

Back up one source folder to a destination. The example includes every documented folder-backup field.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Folder Backup Config",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\UserData",
        "includeHiddenFile": true,
        "includeSubFolder": true,
        "credentialDetails": {
          "credentialUUID": "d97325aa-bbbb-cccc-dddd-eeeeeeeeeeee",
          "credentialID": 301,
          "credentialName": "CONFIG BACKUP"
        },
        "sourceFolder": "C:\\Users\\Public\\Documents",
        "excludeFilesAndFolders": [
          "Temp",
          "Cache",
          "*.tmp"
        ],
        "maxFileSize": {
          "unit": "mb",
          "value": "100"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\BackupServer\\Backups\\ProfileData","sourceFolder":"C:\\Users\\Public\\Desktop","maxFileSize":{"unit":"gb","value":"100"}},{"destinationFolder":"\\\\BackupServer\\Backups\\ProfileData","sourceFolder":"C:\\Users\\Public\\Documents","maxFileSize":{"unit":"gb","value":"100"}}],"label":"Multiple Folder Backup Config","configType":"computer"}'

Sample Request Body - Back Up Multiple Folders

Back up more than one source folder in a single template. Each configDetails entry describes one source folder.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Multiple Folder Backup Config",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\ProfileData",
        "includeHiddenFile": false,
        "includeSubFolder": true,
        "sourceFolder": "C:\\Users\\Public\\Desktop",
        "maxFileSize": {
          "unit": "gb",
          "value": "100"
        }
      },
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\ProfileData",
        "includeHiddenFile": true,
        "includeSubFolder": true,
        "sourceFolder": "C:\\Users\\Public\\Documents",
        "excludeFilesAndFolders": [
          "*.log"
        ],
        "maxFileSize": {
          "unit": "gb",
          "value": "100"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\SecureBackup\\Engineering","sourceFolder":"C:\\Engineering\\Designs","maxFileSize":{"unit":"gb","value":"100"}}],"label":"Folder Backup with Credentials","configType":"computer"}'

Sample Request Body - Back Up Folder Using Credentials

Back up a folder to a shared network destination by using saved credentials for the destination access.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Folder Backup with Credentials",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\SecureBackup\\Engineering",
        "includeHiddenFile": false,
        "includeSubFolder": true,
        "credentialDetails": {
          "credentialUUID": "d97325aa-bbbb-cccc-dddd-eeeeeeeeeeee",
          "credentialID": 301,
          "credentialName": "CONFIG BACKUP"
        },
        "sourceFolder": "C:\\Engineering\\Designs",
        "maxFileSize": {
          "unit": "gb",
          "value": "100"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\BackupServer\\Backups\\HiddenAware","sourceFolder":"C:\\Users\\Public\\Desktop","maxFileSize":{"unit":"gb","value":"100"}}],"label":"Folder Backup Hidden Files","configType":"computer"}'

Sample Request Body - Back Up Folder Including Hidden Files

Back up a folder and include hidden files and folders in the backup set.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Folder Backup Hidden Files",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\HiddenAware",
        "includeHiddenFile": true,
        "includeSubFolder": false,
        "sourceFolder": "C:\\Users\\Public\\Desktop",
        "maxFileSize": {
          "unit": "gb",
          "value": "100"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\BackupServer\\Backups\\Projects","sourceFolder":"C:\\Projects","maxFileSize":{"unit":"gb","value":"100"}}],"label":"Folder Backup with Subfolders","configType":"computer"}'

Sample Request Body - Back Up Folder Including Subfolders

Back up a folder and include its subfolders and their contents.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Folder Backup with Subfolders",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\Projects",
        "includeHiddenFile": false,
        "includeSubFolder": true,
        "sourceFolder": "C:\\Projects",
        "maxFileSize": {
          "unit": "gb",
          "value": "100"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\BackupServer\\Backups\\Logs","sourceFolder":"C:\\Logs","maxFileSize":{"unit":"mb","value":"25"}}],"label":"Folder Backup with File Size Limit","configType":"computer"}'

Sample Request Body - Back Up Folder with File Size Limit

Back up a folder while skipping files that exceed the configured maximum file size.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Folder Backup with File Size Limit",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\Logs",
        "includeHiddenFile": false,
        "includeSubFolder": true,
        "sourceFolder": "C:\\Logs",
        "maxFileSize": {
          "unit": "mb",
          "value": "25"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/folderBackup \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"destinationFolder":"\\\\BackupServer\\Backups\\Profiles","sourceFolder":"C:\\Users\\Default","maxFileSize":{"unit":"gb","value":"100"}}],"label":"Folder Backup with Exclusions","configType":"computer"}'

Sample Request Body - Back Up Folder with File Exclusions

Back up a folder while excluding specific files and folders by name or pattern.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Folder Backup with Exclusions",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "destinationFolder": "\\\\BackupServer\\Backups\\Profiles",
        "includeHiddenFile": false,
        "includeSubFolder": true,
        "sourceFolder": "C:\\Users\\Default",
        "excludeFilesAndFolders": [
          "Cache",
          "Temp",
          "*.log"
        ],
        "maxFileSize": {
          "unit": "gb",
          "value": "100"
        }
      }
    ],
    "enableNotification": false,
    "enableEmailNotify": false,
    "notificationDuration": 6,
    "enableRetry": false,
    "enableRefreshMinRetry": false,
    "email": ""
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Success response returned when the configuration is saved as a reusable template.

Hide Sub-Attributes
templateIdlong

Unique identifier of the created template. Pass it to the Deploy Configuration Template API to deploy this template to targets.

templateNamestring

Name of the created template. It is the label sent in the request.

configTypestring

Type of configuration the template was created for. Allowed values:
computer
user

addedUserstring

Login name of the API user who created the template.

- HTTP code 400

Response Body - application/json
JSON Object

Error response when the request contains invalid or missing required fields.

Hide Sub-Attributes
errorCodelong

Product error code. 50003 = CONFIG_INVALID_INPUT_DATA: configDetails is missing or empty, or the configuration could not be resolved for this endpoint. 20003 = SERVICE_NOT_AVAILABLE: the configuration is deprecated for the requested configType.

errorMsgstring

Localised error message for the error code.

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 413

Response Body - application/json
JSON Object

Error response returned when the server does not have enough free disk space to store the configuration files.

Hide Sub-Attributes
errorCodelong

Product error code. 170013 = INTERNAL_SERVER_ERROR: raised by the storage pre-check before the template is saved.

errorMsgstring

Localised error message for the error code.

- HTTP code 429

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

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object

Error response returned when the template could not be saved because of an unexpected server error.

Hide Sub-Attributes
errorCodelong

Product error code. 1003 = INTERNAL_ERROR: the template could not be persisted. 50001 = CONFIG_INTERNAL_ERROR: an internal configuration error occurred while processing the request.

errorMsgstring

Localised error message for the error code.

Response Examples

Sample Response: HTTP 200 - Back Up Folder

Success response for backupFolder

Copied!
  {
    "templateName": "backupFolder",
    "templateId": 331,
    "configType": "computer",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Back Up Folder

Error response for backupFolder

Copied!
  {
    "errorCode": 50003,
    "errorMsg": "Some Input field missing in configuration"
  }
                
▼ Show full

Sample Response: HTTP 200 - Back Up Multiple Folders

Success response for backupMultipleFolders

Copied!
  {
    "templateName": "backupMultipleFolders",
    "templateId": 345,
    "configType": "computer",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Back Up Multiple Folders

Error response for backupMultipleFolders

Copied!
  {
    "errorCode": 50003,
    "errorMsg": "Some Input field missing in configuration"
  }
                
▼ Show full

Sample Response: HTTP 401

User is not authorized to create the configuration policy

Copied!
  {
    "errorCode": 1001,
    "errorMsg": "Access denied - You are not allowed to access the requested resource."
  }
                
▼ Show full

Sample Response: HTTP 413

Storage pre-check rejected the request before the template was saved

Copied!
  {
    "errorCode": 170013,
    "errorMsg": "The server machine does not have sufficient disk space. Please free up space and try again."
  }
                
▼ Show full

Sample Response: HTTP 429

Request rejected because the caller exceeded the configured rate limit

Copied!
  {
    "errorCode": "IAM0019",
    "url": "/dcapi/config-policies/v2/windows/folderBackup",
    "errorMsg": "The URL /dcapi/config-policies/v2/windows/folderBackup was called too many times. Please retry after a while."
  }
                
▼ Show full

Sample Response: HTTP 500

Unexpected server error while saving the configuration as a template

Copied!
  {
    "errorCode": 1003,
    "errorMsg": "An Internal Error occurred, try again later."
  }
                
▼ 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.