Create a reusable Display 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 Display template to configure display-related settings on Windows target endpoints. For computer configurations, only Primary Resolution, Secondary Resolution, and Font DPI are supported. For user configurations, wallpaper, screensaver, and general desktop settings are supported.

Request URL

https://{serverurl}/dcapi/config-policies/v2/windows/display 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. Allowed values:
computer = applied to the endpoint; supports only Primary Resolution, Secondary Resolution, and Font DPI
user = applied to the logged-on user; supports Wallpaper (Action, Position, Permit User to Modify Wallpaper), Screensaver (Action, Wait Time, On Resume - Display Logon Screen, Permit User to Modify Screensaver), and General desktop settings (Rename My Computer icon, Rename My Network Places icon, Font DPI, Disable Windows Welcome Screen, Disable IntelliMouse Tips Screen, and Disable My Documents)

Display supports both computer and user configurations.

applyAlwaysbooleanOptional

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

applyAtStartupLogonbooleanOptional

Apply the configuration at endpoint startup when configType is computer, or at user logon when configType is user.

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

Exactly one entry. When configType is computer, only Primary Resolution, Secondary Resolution, and Font DPI are supported. When configType is user, use only Wallpaper (Action, Position, Permit User to Modify Wallpaper), Screensaver (Action, Wait Time, On Resume - Display Logon Screen, Permit User to Modify Screensaver), and General desktop settings (Rename My Computer icon, Rename My Network Places icon, Font DPI, Disable Windows Welcome Screen, Disable IntelliMouse Tips Screen, and Disable My Documents).

Show Sub-Attributes
JSON Object
Show Sub-Attributes
primaryWidthintegerOptional

Width of the primary display, measured in pixels. This setting determines the horizontal resolution applied to the primary monitor and is available only for computer configurations.
Allowed values: 800, 1024, 1152, 1280.
Example: primaryWidth: 800.

primaryHeightintegerOptional

Height of the primary display, measured in pixels. This setting determines the vertical resolution applied to the primary monitor and is available only for computer configurations.
Allowed values: 600, 768, 864, 960, 1024.
Example: primaryHeight: 600.

secondaryWidthintegerOptional

Width of the secondary display, measured in pixels. This setting determines the horizontal resolution applied to the secondary monitor and is available only for computer configurations.
Allowed values: 800, 1024, 1152, 1280.
Example: secondaryWidth: 1280.

secondaryHeightintegerOptional

Height of the secondary display, measured in pixels. This setting determines the vertical resolution applied to the secondary monitor and is available only for computer configurations.
Allowed values: 600, 768, 864, 960, 1024.
Example: secondaryHeight: 1024.

fontDPIintegerOptional

Display scaling percentage used to adjust the size of text, icons, and other interface elements on the display. This setting is available for both computer and user configurations.
Allowed values:
100 = 100%, standard display scaling.
125 = 125%, increases the size of interface elements by 25%.
150 = 150%, increases the size of interface elements by 50%.
200 = 200%, doubles the size of interface elements.
Example: fontDPI: 100.

wallpaperActionstringOptional

Action to perform on the desktop w`allpaper. This setting is available only for user configurations and maps to the Wallpaper section.
Allowed values: new = Applies a new wallpaper; disable = Disables the wallpaper; retainExistingSettings = Retains the existing wallpaper settings.
Example: wallpaperAction: "new".

wallpaperFileLocationTypestringOptional

Source location from which the wallpaper image is retrieved when a new wallpaper is applied. This setting is available only for user configurations. The selected value determines whether the wallpaper is downloaded from an HTTP URL or accessed from a network share.
Allowed values: http = Retrieves the wallpaper from an HTTP URL; networkShare = Retrieves the wallpaper from a network share.
Example: wallpaperFileLocationType: "networkShare".

wallpaperFileJSON ObjectOptional

Wallpaper image file to be applied to the desktop when wallpaperAction is new. This setting is available only for user configurations. Upload the file using POST /emsapi/files and provide the fileID and fileName returned by the upload API.
fileID (Mandatory): Identifier of a file uploaded to the server using POST /emsapi/files. The fileID must still be available in the temporary upload folder; expired fileIDs are rejected. fileName: Name of the uploaded wallpaper file. Supported formats: .jpg, .png, .bmp.

Show Sub-Attributes
fileIDlongMandatory

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.

fileNamestringOptional

Uploaded file name.

wallpaperFilePathstringOptional

Path or URL from which the wallpaper image is retrieved. This setting is available only for user configurations. The value should correspond to the location type selected through wallpaperFileLocationType and must provide access to the wallpaper file.
For http, provide the wallpaper file URL; for networkShare, provide the path to the wallpaper file on the network share.
Example: wallpaperFilePath: "\FileServer\Wallpapers\CorporateWallpaper.jpg".

wallpaperPositionstringOptional

Positioning method used to display the wallpaper on the desktop. This setting is available only for user configurations and maps to the Wallpaper > Position option.
Allowed values: tile = Repeats the wallpaper as tiles; center = Centers the wallpaper; stretch = Stretches the wallpaper to fill the desktop; fit = Fits the wallpaper while maintaining its aspect ratio; fill = Fills the desktop while maintaining its aspect ratio; retainExistingSettings = Retains the existing wallpaper position.
Example: wallpaperPosition: "fill".

modifyWallpaperstringOptional

Controls the user permission exposed as Permit User to Modify Wallpaper. This setting is available only for user configurations.
Allowed values: yes = Allows the user to modify the wallpaper; no = Prevents the user from modifying the wallpaper; retainExistingSettings = Retains the existing permission.
Example: modifyWallpaper: "yes".

screenaverActionstringOptional

Action to perform on the screen saver configuration. This setting is available only for user configurations and maps to the Screensaver section.
Allowed values: new = Creates or applies a new screen saver configuration; disable = Disables the screen saver; retainExistingSettings = Retains the existing screen saver settings.
Example: screenaverAction: "new".

screensaverFileLocationTypestringOptional

Source location from which the screen saver file is retrieved when a new screen saver is applied. This setting is available only for user configurations. The selected value determines whether the file is downloaded from an HTTP URL or accessed from a network share.
Allowed values: http = Retrieves the screen saver file from an HTTP URL; networkShare = Retrieves the screen saver file from a network share.
Example: screensaverFileLocationType: "networkShare".

screensaverFileJSON ObjectOptional

Screen saver file to be applied when screenaverAction is new. This setting is available only for user configurations. Upload the file using POST /emsapi/files and provide the fileID and fileName returned by the upload API.
fileID (Mandatory): Identifier of a file uploaded to the server using POST /emsapi/files. The fileID must still be available in the temporary upload folder; expired fileIDs are rejected. fileName: Name of the uploaded screen saver file. Supported format: .scr.

Show Sub-Attributes
fileIDlongMandatory

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.

fileNamestringOptional

Uploaded file name.

screensaverFilePathstringOptional

Path or URL from which the screen saver file is retrieved. This setting is available only for user configurations. The value should correspond to the location type selected through screensaverFileLocationType and must provide access to the screen saver file.
For http, provide the screen saver file URL; for networkShare, provide the path to the screen saver file on the network share.
Example: screensaverFilePath: "\FileServer\ScreenSavers\CorporateScreensaver.scr".

modifyScreensaverstringOptional

Controls the user permission exposed as Permit User to Modify Screensaver. This setting is available only for user configurations.
Allowed values: yes = Allows the user to modify the screensaver; no = Prevents the user from modifying the screensaver; retainExistingSettings = Retains the existing permission.
Example: modifyScreensaver: "yes".

screensaverWaitTimestringOptional

Duration, in minutes, for which the system must remain idle before the screen saver is automatically activated. This setting is available only for user configurations and maps to Screensaver > Wait Time.
Allowed values: 1 - 60 minutes.
Example: screensaverWaitTime: "10".

screensaverShowLogonScreenstringOptional

Controls the On Resume - Display Logon Screen option. This setting is available only for user configurations.
Allowed values: yes = Displays the logon screen; no = Does not display the logon screen; retainExistingSettings = Retains the existing setting.
Example: screensaverShowLogonScreen: "yes".

myComputerIconstringOptional

Name assigned to the My Computer desktop icon. This setting is available only for user configurations and maps to General > Rename My Computer icon.
Example: myComputerIcon: "Finance Workstation".

myNetworkPlacesIconstringOptional

Name assigned to the My Network Places desktop icon. This setting is available only for user configurations and maps to General > Rename My Network Places icon.
Example: myNetworkPlacesIcon: "Corporate Shares".

disableWindowsWelcomeScreenbooleanOptional

Determines whether the Windows Welcome Screen is displayed when users sign in to the system. This setting is available only for user configurations and maps to General > Disable Windows Welcome Screen.
Allowed values: true = Disables the Windows Welcome Screen; false = Enables the Windows Welcome Screen.

disableIntelliMouseTipScreenbooleanOptional

Determines whether the IntelliMouse Tips screen is displayed to users. This setting is available only for user configurations and maps to General > Disable IntelliMouse Tips Screen.
Allowed values: true = Disables the IntelliMouse Tips screen; false = Enables the IntelliMouse Tips screen.

disableMyDocumentsIconbooleanOptional

Determines whether the My Documents icon is displayed on the Windows desktop. This setting is available only for user configurations and maps to General > Disable My Documents.
Allowed values: true = Disables the My Documents icon; false = Enables the My Documents icon.

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

Configure Computer Display▼
Configure Computer Display -- Computer configuration: set only Primary Resolution, Secondary Resolution, and Font DPI.
Configure User Wallpaper -- User configuration: configure Wallpaper Action, Position, and Permit User to Modify Wallpaper.
Disable User Wallpaper -- User configuration: disable wallpaper handling and optionally restrict users from modifying wallpaper.
Retain User Wallpaper Settings -- User configuration: keep the existing wallpaper action, position, and wallpaper modification permission unchanged.
Configure User Screensaver -- User configuration: configure Screensaver Action, Wait Time, On Resume - Display Logon Screen, and Permit User to Modify Screensaver.
Disable User Screensaver -- User configuration: disable screensaver handling and optionally restrict users from modifying the screensaver.
Retain User Screensaver Settings -- User configuration: keep the existing screensaver action, wait time, logon screen, and screensaver modification permission unchanged.
Configure User General Display Settings -- User configuration: rename My Computer and My Network Places, set Font DPI, and manage the Windows Welcome Screen, IntelliMouse Tips Screen, and My Documents icon.
Configure Complete User Display Settings -- User configuration: combine wallpaper, screensaver, and general desktop settings in one display template.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/config-policies/v2/windows/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"Computer Display Settings Config","configType":"computer"}'

Sample Request Body - Configure Computer Display

Computer configuration example. Only primary resolution, secondary resolution, and fontDPI are available when configType is computer.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Computer Display Settings Config",
    "configType": "computer",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "primaryWidth": 1280,
        "secondaryWidth": 1280,
        "fontDPI": 125,
        "secondaryHeight": 1024,
        "primaryHeight": 1024
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"User Wallpaper Settings Config","configType":"user"}'

Sample Request Body - Configure User Wallpaper

User configuration example for the Wallpaper section, including Action, Position, and Permit User to Modify Wallpaper.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "User Wallpaper Settings Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "wallpaperFile": {
          "fileName": "CorporateWallpaper.jpg",
          "fileID": 304
        },
        "wallpaperFilePath": "\\\\FileServer\\Wallpapers\\CorporateWallpaper.jpg",
        "wallpaperPosition": "fill",
        "modifyWallpaper": "no",
        "wallpaperAction": "new",
        "wallpaperFileLocationType": "networkShare"
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"Disable User Wallpaper Config","configType":"user"}'

Sample Request Body - Disable User Wallpaper

User configuration example that disables wallpaper handling while preventing the user from modifying wallpaper.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Disable User Wallpaper Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "wallpaperPosition": "retainExistingSettings",
        "modifyWallpaper": "no",
        "wallpaperAction": "disable"
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"Retain User Wallpaper Config","configType":"user"}'

Sample Request Body - Retain User Wallpaper Settings

User configuration example that retains the existing wallpaper settings and wallpaper modification permission.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Retain User Wallpaper Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "wallpaperPosition": "retainExistingSettings",
        "modifyWallpaper": "retainExistingSettings",
        "wallpaperAction": "retainExistingSettings"
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"User Screensaver Settings Config","configType":"user"}'

Sample Request Body - Configure User Screensaver

User configuration example for the Screensaver section, including Action, Wait Time, On Resume - Display Logon Screen, and Permit User to Modify Screensaver.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "User Screensaver Settings Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "screensaverShowLogonScreen": "yes",
        "screensaverFileLocationType": "networkShare",
        "screenaverAction": "new",
        "screensaverFilePath": "\\\\FileServer\\ScreenSavers\\CorporateScreensaver.scr",
        "modifyScreensaver": "no",
        "screensaverFile": {
          "fileName": "CorporateScreensaver.scr",
          "fileID": 305
        },
        "screensaverWaitTime": "10"
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"Disable User Screensaver Config","configType":"user"}'

Sample Request Body - Disable User Screensaver

User configuration example that disables screensaver handling while preventing the user from modifying the screensaver.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Disable User Screensaver Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "screensaverShowLogonScreen": "retainExistingSettings",
        "screenaverAction": "disable",
        "modifyScreensaver": "no"
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"Retain User Screensaver Config","configType":"user"}'

Sample Request Body - Retain User Screensaver Settings

User configuration example that retains the existing screensaver settings and screensaver modification permission.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Retain User Screensaver Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "screensaverShowLogonScreen": "retainExistingSettings",
        "screenaverAction": "retainExistingSettings",
        "modifyScreensaver": "retainExistingSettings"
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"User General Display Settings Config","configType":"user"}'

Sample Request Body - Configure User General Display Settings

User configuration example for the General section, including Rename My Computer icon, Rename My Network Places icon, Font DPI, Disable Windows Welcome Screen, Disable IntelliMouse Tips Screen, and Disable My Documents.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "User General Display Settings Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "disableIntelliMouseTipScreen": true,
        "myNetworkPlacesIcon": "Corporate Shares",
        "fontDPI": 125,
        "disableMyDocumentsIcon": true,
        "myComputerIcon": "Finance Workstation",
        "disableWindowsWelcomeScreen": true
      }
    ],
    "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/display \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{}],"label":"Complete User Display Settings Config","configType":"user"}'

Sample Request Body - Configure Complete User Display Settings

User configuration example that combines Wallpaper, Screensaver, and General display settings in one request.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Complete User Display Settings Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "screensaverShowLogonScreen": "yes",
        "wallpaperFilePath": "\\\\FileServer\\Wallpapers\\BrandingWallpaper.jpg",
        "screensaverFileLocationType": "networkShare",
        "screenaverAction": "new",
        "wallpaperPosition": "fill",
        "fontDPI": 125,
        "modifyWallpaper": "no",
        "screensaverFilePath": "\\\\FileServer\\ScreenSavers\\BrandingScreensaver.scr",
        "screensaverWaitTime": "10",
        "wallpaperFile": {
          "fileName": "BrandingWallpaper.jpg",
          "fileID": 306
        },
        "disableIntelliMouseTipScreen": true,
        "myNetworkPlacesIcon": "Corporate Shares",
        "disableMyDocumentsIcon": true,
        "myComputerIcon": "Finance Workstation",
        "modifyScreensaver": "no",
        "screensaverFile": {
          "fileName": "BrandingScreensaver.scr",
          "fileID": 307
        },
        "wallpaperAction": "new",
        "disableWindowsWelcomeScreen": true,
        "wallpaperFileLocationType": "networkShare"
      }
    ],
    "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 - Configure Computer Display

Success response for configureComputerDisplay

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

Sample Response: HTTP 400 - Configure Computer Display

Error response for configureComputerDisplay

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

Sample Response: HTTP 200 - Configure User Wallpaper

Success response for configureUserWallpaper

Copied!
  {
    "templateName": "configureUserWallpaper",
    "templateId": 342,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Configure User Wallpaper

Error response for configureUserWallpaper

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

Sample Response: HTTP 200 - Disable User Wallpaper

Success response for disableUserWallpaper

Copied!
  {
    "templateName": "disableUserWallpaper",
    "templateId": 343,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Disable User Wallpaper

Error response for disableUserWallpaper

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

Sample Response: HTTP 200 - Retain User Wallpaper Settings

Success response for retainUserWallpaper

Copied!
  {
    "templateName": "retainUserWallpaper",
    "templateId": 344,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Retain User Wallpaper Settings

Error response for retainUserWallpaper

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

Sample Response: HTTP 200 - Configure User Screensaver

Success response for configureUserScreensaver

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

Sample Response: HTTP 400 - Configure User Screensaver

Error response for configureUserScreensaver

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

Sample Response: HTTP 200 - Disable User Screensaver

Success response for disableUserScreensaver

Copied!
  {
    "templateName": "disableUserScreensaver",
    "templateId": 346,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Disable User Screensaver

Error response for disableUserScreensaver

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

Sample Response: HTTP 200 - Retain User Screensaver Settings

Success response for retainUserScreensaver

Copied!
  {
    "templateName": "retainUserScreensaver",
    "templateId": 347,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Retain User Screensaver Settings

Error response for retainUserScreensaver

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

Sample Response: HTTP 200 - Configure User General Display Settings

Success response for configureUserGeneralDisplay

Copied!
  {
    "templateName": "configureUserGeneralDisplay",
    "templateId": 348,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Configure User General Display Settings

Error response for configureUserGeneralDisplay

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

Sample Response: HTTP 200 - Configure Complete User Display Settings

Success response for configureCompleteUserDisplay

Copied!
  {
    "templateName": "configureCompleteUserDisplay",
    "templateId": 349,
    "configType": "user",
    "addedUser": "admin"
  }
                
▼ Show full

Sample Response: HTTP 400 - Configure Complete User Display Settings

Error response for configureCompleteUserDisplay

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/display",
    "errorMsg": "The URL /dcapi/config-policies/v2/windows/display 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.