Creates a Folder Backup template to back up source folders to a destination on Windows target endpoints. This policy supports only computer configurations.
post /dcapi/config-policies/v2/windows/folderBackup
https://{serverurl}/dcapi/config-policies/v2/windows/folderBackup Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Media type of the request body, as consumed by the endpoint.
Media type of the response body, as produced by the endpoint.
Name of the configuration. Returned as templateName in the response.
Free-text description of the configuration. May be an empty string.
What the configuration is applied to. Must be computer - Folder Backup applies to computers only.
Reapply the configuration at every agent refresh, even when it has already been applied successfully.
Apply the configuration at endpoint startup.
Apply the configuration at the scheduled agent refresh.
Retry the configuration on the endpoint when it fails. noOfRetries sets how many attempts are made.
Honour refreshMinRetry as the minimum gap between two retries at refresh.
Honour logonStartupMinRetry as the minimum gap between two retries at startup or logon.
Number of retry attempts made after a failure. Read only when enableRetry is true.
Minimum number of minutes between two retries at refresh. Read only when enableRefreshMinRetry is true.
Minimum number of minutes between two retries at startup or logon. Read only when enableLogonStartupMinRetry is true.
One entry per source folder to back up, applied in the order they appear. Folder Backup supports only computer configurations.
Endpoint folder whose contents are backed up. Mandatory.
Example: sourceFolder: "C:\Users\Public\Documents".
Destination folder where the contents of the source folder should be backed up.
Example: destinationFolder: "\BackupServer\Backups\UserData".
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: "--"}.
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.
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.
Display name of the saved credential.
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
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.
Maximum file size that can be included in the backup. Mandatory. Files exceeding the specified size will be excluded.
Maximum file size value. Mandatory.
Example: value: "100".
Unit used for the maximum file size, such as mb or gb. Mandatory.
Example: unit: "mb".
Files or folders that should be excluded from the backup.
Supported file formats: *.txt, *.tmp, New Folder*
Send an email to the addresses listed in email once the deployment finishes.
Notify the endpoint user about this deployment. notificationDuration and notificationEnabledDays are read only when this is true.
Comma-separated email addresses notified about the deployment. May be an empty string when enableEmailNotify is false.
How long a deployment notification stays on screen for the endpoint user. Read only when enableNotification is true.
Number of days for which deployment notifications stay enabled. Read only when enableNotification is true.
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"}'Back up one source folder to a destination. The example includes every documented folder-backup field.
{
"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": ""
}
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"}'Back up more than one source folder in a single template. Each configDetails entry describes one source folder.
{
"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": ""
}
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"}'Back up a folder to a shared network destination by using saved credentials for the destination access.
{
"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": ""
}
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"}'Back up a folder and include hidden files and folders in the backup set.
{
"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": ""
}
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"}'Back up a folder and include its subfolders and their contents.
{
"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": ""
}
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"}'Back up a folder while skipping files that exceed the configured maximum file size.
{
"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": ""
}
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"}'Back up a folder while excluding specific files and folders by name or pattern.
{
"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": ""
}
Success response returned when the configuration is saved as a reusable template.
Unique identifier of the created template. Pass it to the Deploy Configuration Template API to deploy this template to targets.
Name of the created template. It is the label sent in the request.
Type of configuration the template was created for. Allowed values:
computer
user
Login name of the API user who created the template.
Error response when the request contains invalid or missing required fields.
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.
Localised error message for the error code.
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Error response returned when the server does not have enough free disk space to store the configuration files.
Product error code. 170013 = INTERNAL_SERVER_ERROR: raised by the storage pre-check before the template is saved.
Localised error message for the error code.
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
Rate limit exceeded message with retry guidance
Error response returned when the template could not be saved because of an unexpected server error.
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.
Localised error message for the error code.
Success response for backupFolder
{
"templateName": "backupFolder",
"templateId": 331,
"configType": "computer",
"addedUser": "admin"
}
Error response for backupFolder
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for backupMultipleFolders
{
"templateName": "backupMultipleFolders",
"templateId": 345,
"configType": "computer",
"addedUser": "admin"
}
Error response for backupMultipleFolders
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
User is not authorized to create the configuration policy
{
"errorCode": 1001,
"errorMsg": "Access denied - You are not allowed to access the requested resource."
}
Storage pre-check rejected the request before the template was saved
{
"errorCode": 170013,
"errorMsg": "The server machine does not have sufficient disk space. Please free up space and try again."
}
Request rejected because the caller exceeded the configured rate limit
{
"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."
}
Unexpected server error while saving the configuration as a template
{
"errorCode": 1003,
"errorMsg": "An Internal Error occurred, try again later."
}
![]()
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.