Retrieve details of a specific configuration

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

Returns the full configuration details for a given collection ID, including config data, target data, and scheduling information.

Endpoints

Request URL

https://{serverurl}/dcapi/configuration/{collectionId}

Scope

DesktopCentralCloud.Configurations.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/collectionDetails.v1+jsonapplication/collectionDetails.v1+jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique numeric identifier of the configuration. Fetch from Get Configurations View .

- Query Parameters

targetOptionstringOptional
isClonebooleanOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/configuration/{collectionId} \
  --header 'Accept: application/collectionDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
collectionIdstring

Unique configuration ID returned as a stringified long.

labelstring

Display name of the configuration.

descriptionstring

User-supplied description of the configuration. Empty string when not set.

platformstring

Target platform — windows, mac, or linux.

collectionTypestring

Configuration type: 1 = Single Config, 2 = Collection.

configTypestring

Targeting category — typically 'Computer' or 'User'.

statusstring

Current state of the configuration — e.g., 'Ready To Execute', 'Deployed', 'Suspended', 'Trashed'.

statusLocalizedstring

Localised, human-readable status string for display in the UI.

statusImagestring

Relative path to the status icon image used by the UI.

statestring

Numeric state code mirroring 'status' (used internally for state-machine transitions).

applyAlwaysboolean

Whether the configuration is applied on every refresh cycle.

applyAtStartupLogonboolean

Whether the configuration is applied at system startup or user logon.

applyAtRefreshboolean

Whether the configuration is applied at agent refresh.

enableRetryboolean

Whether retry on failure is enabled.

noOfRetriesstring

Maximum number of retry attempts.

enableRefreshMinRetryboolean

Whether the minimum retry interval at refresh is enabled.

refreshMinRetrystring

Minimum retry interval at refresh, in minutes.

enableLogonStartupMinRetryboolean

Whether the minimum retry interval at logon/startup is enabled.

logonStartupMinRetrystring

Minimum retry interval at logon/startup, in minutes.

enableNotificationboolean

Whether email notification is enabled for deployment events.

emailstring

Comma-separated list of recipient email addresses for notifications. Empty string when notifications are disabled.

continueDeploymentboolean

Whether to continue deployment on partial failure. Returned only for Patch configurations.

isArmProcessorExistsboolean

Whether ARM-architecture computers exist in the network. Returned only for Linux configurations.

allowRetryModifyboolean

Whether the requesting user is permitted to modify retry settings on this configuration.

allowNotificationModifyboolean

Whether the requesting user is permitted to modify notification settings on this configuration.

allowSaveTemplateboolean

Whether the requesting user is permitted to save this configuration as a reusable template.

schedulerSettingsJSON Object

Scheduler configuration of the collection (e.g., enableInstallAfter, enableExpiry, schedule type/time). Structure varies based on the configuration type.

Show Sub-Attributes
targetDataJSON Object

Target group and refine-filter definitions for this configuration.

Show Sub-Attributes
isTechMapWithCGboolean

Whether the technician-to-Custom-Group mapping restriction applies to this target selection.

isTechMapWithROboolean

Whether the technician-to-Remote-Office mapping restriction applies to this target selection.

isUserConfigBasedOnROorWGstring

For user configurations, indicates whether targeting is based on Remote Office / Workgroup ('true') or AD Domain ('false'). Returned as a stringified boolean.

allTargetsJSON Array

Array of target group definitions. Each entry pairs a main target (Remote Office, Custom Group, Domain, etc.) with optional refine filters that include or exclude specific computers/users.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
mainTargetJSON Object

The primary target scope for this group (e.g., Remote Office, Custom Group, Domain).

Show Sub-Attributes
targetTypestring

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON Array

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestring

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstring

Display name of the target entity.

domainstring

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstring

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

computerRefineTargetJSON Object

Optional refine filter restricting the main target to specific computers via include/exclude selections. Returned for computer-based configurations.

Show Sub-Attributes
includeTargetsJSON Array

Refine selections that further restrict the main target — only resources matching these entries are included.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestring

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON Array

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestring

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstring

Display name of the target entity.

domainstring

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstring

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

excludeTargetsJSON Array

Refine selections that exclude resources from the main target. Returned only when the configuration explicitly excludes specific resources.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestring

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON Array

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestring

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstring

Display name of the target entity.

domainstring

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstring

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

userRefineTargetJSON Object

Optional refine filter restricting the main target to specific users via include/exclude selections. Returned for user-based configurations.

Show Sub-Attributes
includeTargetsJSON Array

Refine selections that further restrict the main target — only resources matching these entries are included.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestring

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON Array

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestring

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstring

Display name of the target entity.

domainstring

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstring

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

excludeTargetsJSON Array

Refine selections that exclude resources from the main target. Returned only when the configuration explicitly excludes specific resources.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestring

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON Array

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestring

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstring

Display name of the target entity.

domainstring

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstring

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

configDetailsJSON Array

Array of configuration detail objects holding config-specific settings/parameters.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
configNamestring

Name/type of the configuration (e.g., PATCH_INSTALL, FIREWALL_RULES, CUSTOM_SCRIPT)

configIdlong

Unique identifier of the configuration

detailsarray

Array of config-specific detail objects containing settings and parameters

createdUserNamestring

Login name of the user who created the configuration.

createdUserIdstring

User ID of the configuration creator, returned as a stringified long.

createdTimestring

Timestamp when the configuration was created (e.g., 'Apr 15, 2026 05:25 PM').

modifiedUserNamestring

Login name of the user who last modified the configuration.

modifiedUserIdstring

User ID of the user who last modified the configuration, returned as a stringified long.

modifiedTimestring

Timestamp when the configuration was last modified (e.g., 'Apr 15, 2026 05:25 PM').

targetModifiedBystring

Login name of the user who last modified the target data.

targetModifiedTimestring

Timestamp when the configuration's target data was last modified (e.g., 'Apr 15, 2026 05:25 PM').

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

RESOURCE_NOT_AVAILABLE: the specified collectionId does not exist in the system

error_descriptionstring

Message indicating the configuration was not found

Possible Response Codes

200HTTP code
401HTTP code
404HTTP code

Sample Response: HTTP 200

Custom Script configuration for a Windows computer target. Field set is representative; per-config-type fields under configDetails.details vary.

Copied!
  {
    "applyAtRefresh": false,
    "modifiedUserName": "admin",
    "modifiedTime": "Apr 15, 2026 05:25 PM",
    "applyAlways": false,
    "description": "",
    "configType": "Computer",
    "noOfRetries": 2,
    "platform": "windows",
    "createdUserName": "admin",
    "configDetails": [
      {
        "configName": "CUSTOM_SCRIPT",
        "details": [
          {
            "useCredential": 1,
            "isDynamicArgsPresent": false,
            "execFrequency": "once",
            "executionType": "commandLine",
            "execExpTime": "",
            "execCount": 0,
            "detailId": "1502",
            "exitCodes": "0",
            "enableLogging": true,
            "command": "hostname"
          }
        ]
      }
    ],
    "enableNotification": false,
    "createdTime": "Apr 15, 2026 05:25 PM",
    "state": 0,
    "collectionId": "1502",
    "enableRefreshMinRetry": true,
    "email": "",
    "statusImage": "images/readytodeploy.png",
    "targetData": {
      "isTechMapWithCG": false,
      "allTargets": [
        {
          "mainTarget": {
            "selectedValues": [
              {
                "isTargetRemoved": "false",
                "idValue": "1",
                "label": "MyOrg Default Remote Office"
              }
            ],
            "targetType": "2"
          },
          "computerRefineTarget": {
            "includeTargets": [
              {
                "selectedValues": [
                  {
                    "isTargetRemoved": "true",
                    "domain": "WORKGROUP",
                    "idValue": "601",
                    "label": "EMSI-W11-2"
                  }
                ],
                "targetType": "8"
              }
            ]
          }
        }
      ],
      "isTechMapWithRO": false,
      "isUserConfigBasedOnROorWG": "false"
    },
    "createdUserId": "1",
    "allowRetryModify": true,
    "label": "MyConfiguration12",
    "targetModifiedBy": "admin",
    "applyAtStartupLogon": false,
    "refreshMinRetry": 1,
    "collectionType": 1,
    "targetModifiedTime": "Apr 15, 2026 05:25 PM",
    "enableLogonStartupMinRetry": true,
    "allowNotificationModify": true,
    "statusLocalized": "Deployed",
    "logonStartupMinRetry": 1,
    "modifiedUserId": "1",
    "allowSaveTemplate": true,
    "schedulerSettings": {
      "enableInstallAfter": false,
      "enableExpiry": false
    },
    "enableRetry": true,
    "status": "Ready To Execute"
  }
▼ Show full

Sample Response: HTTP 401

User lacks read role for this config type

Copied!
  {
    "error_description": "Access denied - You are not allowed to access the requested resource.",
    "error_code": "UAC_UNAUTHORIZED"
  }
▼ Show full

Sample Response: HTTP 404

Collection ID does not exist

Copied!
  {
    "error_description": "The requested configuration does not exist",
    "error_code": "RESOURCE_NOT_AVAILABLE"
  }
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.