Create a reusable Drive Mapping 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 Drive Mapping template to map network drives on Windows target endpoints. The configuration is saved as a reusable template that can be deployed later. This configuration applies to users, so configType must be user. Each entry in configDetails[0].driveMapDetails maps or removes one drive letter, and preferenceDetails carries the settings shared by every entry. Use the returned templateId with the Deploy Configuration Template API to deploy it to targets.

Request URL

https://{serverurl}/dcapi/config-policies/v2/windows/driveMap 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 user - Drive Mapping applies to users only.

applyAlwaysbooleanOptional

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

applyAtStartupLogonbooleanOptional

Apply the configuration at user logon.

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, holding the driveMapDetails list of drive letters to map or remove together with the preferenceDetails shared by all of them.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
driveMapDetailsJSON ArrayMandatory

One entry per drive letter to map or remove, applied in the order they appear.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
driveNamestringOptional

Drive letter, A to Z, to map or remove on the endpoint. Mandatory for every entry.

drivePathstringOptional

UNC path of the network share the drive letter points at (e.g., "\server\share"). Required when action is add; ignored for remove.

hideFromExplorerbooleanOptional

Hide the mapped drive from File Explorer while keeping it reachable by its drive letter. Read only when action is add. Default: false

actionstringOptional

Whether to map the drive letter or unmap it. Allowed values:
add = maps driveName to drivePath
remove = unmaps driveName and ignores drivePath, explorerLabel and hideFromExplorer

Matched case-insensitively.

explorerLabelstringOptional

Label shown next to the drive letter in File Explorer instead of the share name. Read only when action is add.

preferenceDetailsJSON ObjectOptional

Settings that apply to every entry in driveMapDetails.

Show Sub-Attributes
disconnectExistingDrivesintegerOptional

Whether every drive already mapped on the endpoint is disconnected before this configuration is applied. Allowed values:
0 = No
1 = Yes.

continueOnFailureintegerOptional

Whether the remaining entries in driveMapDetails are still applied after one of them fails. Allowed values:
0 = No (stop at the first failure)
1 = Yes (carry on).

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

Deploy Drive Map▼
Deploy Drive Map -- Map a network drive and label it in File Explorer.
Map and Remove Drives -- Map one drive letter and remove another in the same configuration.

Sample Request

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

Sample Request Body - Deploy Drive Map

Map a single network drive. action add requires drivePath, and preferenceDetails takes 0 = No and 1 = Yes.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Sample DRIVE_MAP Config",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "driveMapDetails": [
          {
            "hideFromExplorer": false,
            "explorerLabel": "Shared",
            "action": "add",
            "driveName": "Z",
            "drivePath": "\\\\fileserver\\shared"
          }
        ],
        "preferenceDetails": {
          "disconnectExistingDrives": 0,
          "continueOnFailure": 0
        }
      }
    ],
    "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/driveMap \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"configDetails":[{"driveMapDetails":[{},{}]}],"label":"Map Network Drive","configType":"user"}'

Sample Request Body - Map and Remove Drives

Map one drive letter and remove another in a single configuration. action remove only needs driveName - drivePath, explorerLabel and hideFromExplorer are ignored. continueOnFailure 1 keeps applying the remaining entries when one of them fails.

Copied!
  {
    "applyAtRefresh": false,
    "applyAlways": false,
    "description": "Created through the Config Policies API.",
    "label": "Map Network Drive",
    "configType": "user",
    "applyAtStartupLogon": true,
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "notificationEnabledDays": 3,
    "enableLogonStartupMinRetry": false,
    "logonStartupMinRetry": 1,
    "configDetails": [
      {
        "driveMapDetails": [
          {
            "hideFromExplorer": false,
            "explorerLabel": "Projects",
            "action": "add",
            "driveName": "P",
            "drivePath": "\\\\fileserver\\projects"
          },
          {
            "action": "remove",
            "driveName": "X"
          }
        ],
        "preferenceDetails": {
          "disconnectExistingDrives": 1,
          "continueOnFailure": 1
        }
      }
    ],
    "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 - Deploy Drive Map

Success response for deployDriveMap

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

Sample Response: HTTP 400 - Deploy Drive Map

Error response for deployDriveMap

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

Sample Response: HTTP 200 - Map and Remove Drives

Success response for mapDrive

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

Sample Response: HTTP 400 - Map and Remove Drives

Error response for mapDrive

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