# Retrieve details of a specific configuration

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

## Endpoint

`GET /dcapi/configuration/{collectionId}`

## Request

### Request URL

`https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/dcapi/configuration/{collectionId}`

### Scope

`DesktopCentralCloud.Configurations.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** (`string`, required): `application/collectionDetails.v1+json`

#### Path Parameters

- **collectionId** (`string`, required): The unique numeric identifier of the configuration. Fetch from [Get Configurations View](https://www.manageengine.com/products/desktop-central/help/api/cloud/deployment-fw-get-configurations-view.html).

#### Query Parameters

- **targetOption** (`string`, optional)
- **isClone** (`boolean`, optional)

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/configuration/{collectionId} \
  --header 'Accept: application/collectionDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP 200

Response body: `application/json`

| Field | Type | Description |
|---|---|---|
| collectionId | string | Unique configuration ID returned as a stringified long. |
| label | string | Display name of the configuration. |
| description | string | User-supplied description of the configuration. Empty string when not set. |
| platform | string | Target platform — windows, mac, or linux. |
| collectionType | string | Configuration type: 1 = Single Config, 2 = Collection. |
| configType | string | Targeting category — typically 'Computer' or 'User'. |
| status | string | Current state of the configuration — e.g., 'Ready To Execute', 'Deployed', 'Suspended', 'Trashed'. |
| statusLocalized | string | Localised, human-readable status string for display in the UI. |
| statusImage | string | Relative path to the status icon image used by the UI. |
| state | string | Numeric state code mirroring 'status' (used internally for state-machine transitions). |
| applyAlways | boolean | Whether the configuration is applied on every refresh cycle. |
| applyAtStartupLogon | boolean | Whether the configuration is applied at system startup or user logon. |
| applyAtRefresh | boolean | Whether the configuration is applied at agent refresh. |
| enableRetry | boolean | Whether retry on failure is enabled. |
| noOfRetries | string | Maximum number of retry attempts. |
| enableRefreshMinRetry | boolean | Whether the minimum retry interval at refresh is enabled. |
| refreshMinRetry | string | Minimum retry interval at refresh, in minutes. |
| enableLogonStartupMinRetry | boolean | Whether the minimum retry interval at logon/startup is enabled. |
| logonStartupMinRetry | string | Minimum retry interval at logon/startup, in minutes. |
| enableNotification | boolean | Whether email notification is enabled for deployment events. |
| email | string | Comma-separated list of recipient email addresses for notifications. Empty string when notifications are disabled. |
| continueDeployment | boolean | Whether to continue deployment on partial failure. Returned only for Patch configurations. |
| isArmProcessorExists | boolean | Whether ARM-architecture computers exist in the network. Returned only for Linux configurations. |
| allowRetryModify | boolean | Whether the requesting user is permitted to modify retry settings on this configuration. |
| allowNotificationModify | boolean | Whether the requesting user is permitted to modify notification settings on this configuration. |
| allowSaveTemplate | boolean | Whether the requesting user is permitted to save this configuration as a reusable template. |
| schedulerSettings | JSON Object | Scheduler configuration of the collection, such as `enableInstallAfter`, `enableExpiry`, and schedule type/time. Structure varies based on the configuration type. |
| targetData | JSON Object | Target group and refine-filter definitions for this configuration. |
| configDetails | JSON Array | Array of configuration detail objects holding config-specific settings and parameters. |
| createdUserName | string | Login name of the user who created the configuration. |
| createdUserId | string | User ID of the configuration creator, returned as a stringified long. |
| createdTime | string | Timestamp when the configuration was created, for example, `Apr 15, 2026 05:25 PM`. |
| modifiedUserName | string | Login name of the user who last modified the configuration. |
| modifiedUserId | string | User ID of the user who last modified the configuration, returned as a stringified long. |
| modifiedTime | string | Timestamp when the configuration was last modified, for example, `Apr 15, 2026 05:25 PM`. |
| targetModifiedBy | string | Login name of the user who last modified the target data. |
| targetModifiedTime | string | Timestamp when the configuration's target data was last modified, for example, `Apr 15, 2026 05:25 PM`. |

#### `targetData` Properties

| Field | Type | Description |
|---|---|---|
| isTechMapWithCG | boolean | Whether the technician-to-Custom-Group mapping restriction applies to this target selection. |
| isTechMapWithRO | boolean | Whether the technician-to-Remote-Office mapping restriction applies to this target selection. |
| isUserConfigBasedOnROorWG | string | For user configurations, indicates whether targeting is based on Remote Office / Workgroup (`true`) or AD Domain (`false`). Returned as a stringified boolean. |
| allTargets | JSON Array | Array of target group definitions. Each entry pairs a main target, such as Remote Office, Custom Group, or Domain, with optional refine filters that include or exclude specific computers or users. |

#### `configDetails` Properties

| Field | Type | Description |
|---|---|---|
| configName | string | Name or type of the configuration, such as `PATCH_INSTALL`, `FIREWALL_RULES`, or `CUSTOM_SCRIPT`. |
| configId | long | Unique identifier of the configuration. |
| details | array | Array of config-specific detail objects containing settings and parameters. |

### Sample Response: HTTP 200

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

```json
{
  "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"
}
```

### HTTP 401

Response body: `application/json`

| Field | Type | Description |
|---|---|---|
| errorCode | long | Unauthorized error code returned when authentication credentials are missing, expired, or invalid (`authentication=required`). |
| errorMsg | string | Authentication failure reason. |

### Sample Response: HTTP 401

User lacks read role for this config type.

```json
{
  "error_description": "Access denied - You are not allowed to access the requested resource.",
  "error_code": "UAC_UNAUTHORIZED"
}
```

### HTTP 404

Response body: `application/json`

| Field | Type | Description |
|---|---|---|
| error_code | string | `RESOURCE_NOT_AVAILABLE`: the specified `collectionId` does not exist in the system. |
| error_description | string | Message indicating the configuration was not found. |

### Sample Response: HTTP 404

Collection ID does not exist.

```json
{
  "error_description": "The requested configuration does not exist",
  "error_code": "RESOURCE_NOT_AVAILABLE"
}
```

## Rate Limit

**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.