Creates a Registry template to manage Windows registry keys and values on target endpoints. The configuration is saved as a reusable template that can be deployed later. registryType manual defines each entry inline through headerKey, subKey, valueName and valueData; registryType import applies exported .reg files supplied through registryFiles or registryShareFilePaths. Use the returned templateId with the Deploy Configuration Template API to deploy it to targets.
post /dcapi/config-policies/v2/windows/registry
https://{serverurl}/dcapi/config-policies/v2/windows/registry 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. Allowed values:
computer = applied to the endpoint
user = applied to the logged-on user
Reapply the configuration at every agent refresh, even when it has already been applied successfully.
Apply the configuration at endpoint startup when configType is computer, or at user logon when configType is user.
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 registry action, applied in the order they appear.
How the entry is defined. Allowed values:
manual = describes the change inline through headerKey, subKey, valueName and valueData
import = applies an exported .reg file supplied through registryFiles or registryShareFilePaths
Mandatory.
Registry operation to perform. Allowed values:
writeValue = creates or updates the value named in valueName
deleteValue = removes that value
addKey = creates the key in subKey
deleteKey = removes that key and everything under it
Matched case-insensitively - createKey is not accepted.
Registry hive the change is made in. Allowed values:
HKLM = HKEY_LOCAL_MACHINE (machine-wide settings)
HKCU = HKEY_CURRENT_USER (preferences of the logged-on user)
HKCR = HKEY_CLASSES_ROOT (file associations, OLE information and shortcut data)
HKCC = HKEY_CURRENT_CONFIG (the hardware profile currently in use)
HKU = HKEY_USERS.Default (the default profile preferences). Which hives apply depends on configType: a computer configuration uses HKLM = HKEY_LOCAL_MACHINE and HKU = HKEY_USERS.Default, while a user configuration uses HKCR = HKEY_CLASSES_ROOT
HKCC = HKEY_CURRENT_CONFIG
HKCU = HKEY_CURRENT_USER and HKU = HKEY_USERS.Default.
Path of the key under headerKey, without the hive prefix (e.g., "SOFTWARE\MyApp\Settings").
Type of the registry value being written. Allowed values:
regSZ = string
regExpandSZ = expandable string
regMultiSZ = multi-string written through multiValueData
regBinary = binary
regDword = 32-bit number
regQword = 64-bit number
Read only when action is writeValue. Matched case-insensitively, so regDword is accepted but regDWORD is not.
Name of the registry value to write or delete. Required when action is writeValue or deleteValue; ignored for addKey and deleteKey.
Data written into valueName, always sent as a string even for numeric types (e.g., regDword). Read only when action is writeValue and dataType is not regMultiSZ.
Data written into valueName when dataType is regMultiSZ, holding the individual strings of the multi-string value. Ignored for every other data type.
Saved credential used to reach the network share holding the .reg files, 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.
Where the .reg files come from when registryType is import. Allowed values:
http = the files uploaded in registryFiles
networkShare = the UNC paths in registryShareFilePaths
Matched case-insensitively.
Exported .reg files to import, each already uploaded through POST /emsapi/files. Read only when registryType is import and fileLocationType is http.
Identifier of a file already uploaded to the server. Upload the file first (POST /emsapi/files) and pass the fileID returned by that call. A fileID that has expired from the temporary upload folder is rejected.
Uploaded file name.
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/registry \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"registryType":"manual"}],"label":"Sample CUSTOM_REGISTRY Config","configType":"computer"}'Write a string value under HKEY_LOCAL_MACHINE. headerKey accepts HKLM, HKCU, HKCR, HKCC and HKU, of which a computer configuration uses HKLM and HKU while a user configuration uses HKCR, HKCC, HKCU and HKU. dataType accepts regSZ, regExpandSZ, regMultiSZ, regBinary, regDword and regQword. credentialID -1 means no saved credential is used.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Sample CUSTOM_REGISTRY Config",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"registryType": "manual",
"subKey": "SOFTWARE\\MyApp",
"valueName": "Version",
"credentialDetails": {
"credentialUUID": "--",
"credentialID": -1,
"credentialName": ""
},
"dataType": "regSZ",
"action": "writeValue",
"headerKey": "HKLM",
"valueData": "1.0"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/registry \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"registryType":"manual"}],"label":"Delete Registry Value","configType":"computer"}'Delete a single value from a key. action deleteValue needs headerKey, subKey and valueName; dataType and valueData are ignored. Use deleteKey to remove the key itself.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Delete Registry Value",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"registryType": "manual",
"subKey": "SOFTWARE\\MyApp",
"valueName": "OldSetting",
"action": "deleteValue",
"headerKey": "HKLM"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/registry \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"registryType":"manual"}],"label":"Create Registry Key","configType":"computer"}'Create a registry key without writing a value into it. The accepted action is addKey - createKey is rejected with HTTP 400.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Create Registry Key",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"registryType": "manual",
"subKey": "SOFTWARE\\MyCompany\\NewApp",
"action": "addKey",
"headerKey": "HKLM"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/registry \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"registryType":"manual"}],"label":"Set DWORD Registry Value","configType":"user"}'Write a DWORD value under HKEY_CURRENT_USER. HKCU is a user hive, so the configuration is sent as configType user. dataType must be regDword - regDWORD is rejected with HTTP 400 - and valueData carries the number as a string.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Set DWORD Registry Value",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"registryType": "manual",
"subKey": "SOFTWARE\\MyApp\\Settings",
"valueName": "EnableFeature",
"dataType": "regDword",
"action": "writeValue",
"headerKey": "HKCU",
"valueData": "1"
}
],
"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 deployRegistry
{
"templateName": "deployRegistry",
"templateId": 316,
"configType": "computer",
"addedUser": "admin"
}
Error response for deployRegistry
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for registryDeleteValue
{
"templateName": "registryDeleteValue",
"templateId": 317,
"configType": "computer",
"addedUser": "admin"
}
Error response for registryDeleteValue
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for registryCreateKey
{
"templateName": "registryCreateKey",
"templateId": 318,
"configType": "computer",
"addedUser": "admin"
}
Error response for registryCreateKey
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for registryDwordValue
{
"templateName": "registryDwordValue",
"templateId": 319,
"configType": "computer",
"addedUser": "admin"
}
Error response for registryDwordValue
{
"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/registry",
"errorMsg": "The URL /dcapi/config-policies/v2/windows/registry 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.