Creates an IP Printer template to set up IP-based printers on Windows target endpoints. This policy supports both computer and user configurations, but setting an IP printer as the default printer is supported only for user configurations.
post /dcapi/config-policies/v2/windows/ipPrinter
https://{serverurl}/dcapi/config-policies/v2/windows/ipPrinter 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
IP Printer supports both computer and user configurations. setAsDefault is supported only when configType is 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 IP printer to add or remove, applied in the order they appear. IP Printer supports both computer and user configurations; setAsDefault is supported only for user configurations.
Determines how the IP printer entry is managed.
Allowed values:
add = Registers a new IP printer.
delete = Removes an existing IP printer.
Example: action: "add".
Whether all configured IP printers should be deleted.
Allowed values:
true = Deletes all IP printers.
false = Deletes only the specified IP printer.
DNS name or IP address of the IP printer.
Example: dnsNameOrIP: "192.168.1.100".
Display name of the IP printer.
Example: printerDisplayName: "Office Laser Printer".
Communication protocol to be used for the IP printer.
Allowed values: RAW, LPR
Example: protocol: "RAW".
Port number used to communicate with the IP printer.
Example: portNumber: 9100.
Name of the printer port to be used for the IP printer.
Example: portName: "IP_192.168.1.100".
Whether an existing printer configuration should be overwritten.
Allowed values:
true = Overwrites the existing printer configuration.
false = Retains the existing printer configuration.
Whether the IP printer should be set as the default printer. This setting is supported only for user configurations.
Allowed values:
true = Sets the IP printer as the default printer for the user.
false = Does not set the IP printer as the default printer.
For computer configurations, omit this field or set it to false.
Type of printer driver to be used.
Allowed values:
newDriver = Uses a new printer driver supplied with the configuration.
preInstalledDriver = Uses a printer driver that is already installed on the computer.
sharedNetworkPrinter = Uses the driver associated with a shared network printer.
Example: driverType: "newDriver".
Printer driver file to be used for the IP printer. Upload the driver file using POST /emsapi/files and reference the uploaded file using its fileID and fileName
Supported file formats: .exe, .zip
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.
Name of the printer driver to be used for the IP printer.
Example: driverName: "Generic Printer Driver".
List of INF files required for installing the printer driver.
Path to the INF file required to install the printer driver.
This field is enabled when driverType = "newDriver"
Example: infFile: "C:\Drivers\Printer\driver.inf".
Whether credentials should be used when connecting to the printer.
Allowed values:
true = Uses the specified credentials.
false = Does not use credentials.
Credentials required to connect to the printer or shared printer location. 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.
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/ipPrinter \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"add"}],"label":"User IP Printer Config","configType":"user"}'Configure one user-scoped IP printer entry with every documented field. setAsDefault is supported only when configType is user.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "User IP Printer Config",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"driverFile": {
"fileName": "PrinterDriver.zip",
"fileID": 308
},
"useCredential": true,
"infFileList": [
"driver.inf",
"printer.inf"
],
"printerDisplayName": "Office Laser Printer",
"deleteAllIPPrinter": false,
"portName": "IP_192.168.1.100",
"driverType": "newDriver",
"portNumber": 9100,
"setAsDefault": true,
"dnsNameOrIP": "192.168.1.100",
"protocol": "RAW",
"credentialDetails": {
"credentialUUID": "d97325aa-bbbb-cccc-dddd-eeeeeeeeeeee",
"credentialID": 301,
"credentialName": "CONFIG PRINTER"
},
"action": "add",
"driverName": "Generic Printer Driver",
"infFile": "C:\\Drivers\\Printer\\driver.inf",
"overWrite": true,
"sharedPrinterPath": "\\\\PrintServer\\OfficePrinter"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/ipPrinter \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"delete"}],"label":"Delete One IP Printer","configType":"computer"}'Delete one configured IP printer without removing the others. action delete with deleteAllIPPrinter false uses printerDisplayName to identify the printer entry to remove.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Delete One IP Printer",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"printerDisplayName": "Office Laser Printer",
"action": "delete",
"deleteAllIPPrinter": false
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/ipPrinter \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"delete"}],"label":"Delete All IP Printers","configType":"computer"}'Delete every configured IP printer from the endpoint.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Delete All IP Printers",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"action": "delete",
"deleteAllIPPrinter": true
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/ipPrinter \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"add"}],"label":"Installed Driver Printer Config","configType":"computer"}'Add an IP printer using a printer driver that is already installed on the endpoint.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Installed Driver Printer Config",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"dnsNameOrIP": "192.168.10.45",
"protocol": "RAW",
"printerDisplayName": "Finance Laser Printer",
"action": "add",
"driverName": "HP Universal Printing PCL 6",
"deleteAllIPPrinter": false,
"portName": "IP_192.168.10.45",
"driverType": "preInstalledDriver",
"portNumber": 9100,
"overWrite": false,
"setAsDefault": false
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/ipPrinter \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"add"}],"label":"Shared Network Printer Config","configType":"computer"}'Add an IP printer that uses the driver already published by a shared network printer. driverType sharedNetworkPrinter requires sharedPrinterPath and can optionally use saved credentials.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Shared Network Printer Config",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"useCredential": true,
"printerDisplayName": "Shared Hallway Printer",
"deleteAllIPPrinter": false,
"portName": "IP_192.168.20.25",
"driverType": "sharedNetworkPrinter",
"portNumber": 9100,
"setAsDefault": false,
"dnsNameOrIP": "192.168.20.25",
"protocol": "RAW",
"credentialDetails": {
"credentialUUID": "d97325aa-bbbb-cccc-dddd-eeeeeeeeeeee",
"credentialID": 301,
"credentialName": "CONFIG PRINTER"
},
"action": "add",
"overWrite": true,
"sharedPrinterPath": "\\\\PrintServer\\HallwayPrinter"
}
],
"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 addIpPrinter
{
"templateName": "addIpPrinter",
"templateId": 334,
"configType": "user",
"addedUser": "admin"
}
Error response for addIpPrinter
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for deleteIpPrinter
{
"templateName": "deleteIpPrinter",
"templateId": 359,
"configType": "computer",
"addedUser": "admin"
}
Error response for deleteIpPrinter
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for deleteAllIpPrinters
{
"templateName": "deleteAllIpPrinters",
"templateId": 348,
"configType": "computer",
"addedUser": "admin"
}
Error response for deleteAllIpPrinters
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for addPrinterWithInstalledDriver
{
"templateName": "addPrinterWithInstalledDriver",
"templateId": 357,
"configType": "computer",
"addedUser": "admin"
}
Error response for addPrinterWithInstalledDriver
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for addSharedNetworkPrinter
{
"templateName": "addSharedNetworkPrinter",
"templateId": 360,
"configType": "computer",
"addedUser": "admin"
}
Error response for addSharedNetworkPrinter
{
"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/ipPrinter",
"errorMsg": "The URL /dcapi/config-policies/v2/windows/ipPrinter 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.