Retrieve details of a specific configuration template

Returns the full details of a specific configuration template including its configuration data and metadata.

Endpoints

get /dcapi/configuration/template/{templateId}

Copy full URL

Request URL

https://{server-hostname}:8383/dcapi/configuration/template/{templateId}

Scope

Configurations.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/templateDetails.v1+jsonCopied!

- Path Parameters

templateIdstringMandatory

The unique numeric identifier of the configuration template whose details are to be retrieved.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/configuration/template/{templateId} \
  --header 'Accept: application/templateDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/configuration/template/{templateId}"))
        .header("Accept", "application/templateDetails.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/templateDetails.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/configuration/template/{templateId}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/templateDetails.v1+json");

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/configuration/template/{templateId}"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/templateDetails.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/configuration/template/{templateId}' -Method GET -Headers $headers

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

collectionIdlong

The internal collection ID associated with this template

labelstring

Display name of the template

descriptionstring

Description of the template

platformstring

Target platform — windows, mac, or linux

collectionTypestring

Configuration type: 1 = Single Config, 2 = Collection

configTypestring

The configuration type name (e.g., FIREWALL_RULES, PATCH_INSTALL, CUSTOM_SCRIPT)

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

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

enableRetryboolean

Whether retry on failure is enabled

noOfRetriesstring

Number of retry attempts

enableRefreshMinRetryboolean

Whether the minimum retry interval at refresh is enabled

enableLogonStartupMinRetryboolean

Whether the minimum retry interval at logon/startup is enabled

refreshMinRetrystring

Minimum retry interval at refresh (in minutes)

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

continueDeploymentboolean

Whether to continue deployment on partial failure. Returned only for Patch configurations (PATCH_INSTALL, PATCH_UNINSTALL, MAC_PATCH_INSTALL, LINUX_PATCH_INSTALL).

schedulerSettingsJSON object

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

Show Sub-Attributes

createdFromstring

Source indicator of the template (0 = locally created)

isGlobalTemplateboolean

Whether the template is a Global Template (MSP)

sourceTemplateIdlong

The originating template ID. Returned only when the template is a user-defined Global Template.

templateTypestring

Template origin — 'userDefined' for templates created by a user, or 'preDefined' for system-shipped templates

isUsedInConfigboolean

Whether this template is currently referenced by any configuration. Returned only for user-defined templates.

tagNamestring

Category tag of the pre-defined template (e.g., PATCH_MANAGEMENT). Returned only for pre-defined templates.

createdUserNamestring

createdUserIdlong

User ID of the template creator. Returned only for user-defined templates.

createdTimestring

Timestamp when the template was created (yyyy-MM-dd HH:mm:ss). Returned only for user-defined templates.

modifiedUserNamestring

modifiedUserIdlong

User ID of the user who last modified the template. Returned only for user-defined templates.

modifiedTimestring

Timestamp when the template was last modified (yyyy-MM-dd HH:mm:ss). Returned only for user-defined templates.

targetModifiedTimestring

Timestamp when the template's target data was last modified (yyyy-MM-dd HH:mm:ss). Returned only for user-defined templates.

targetModifiedBystring

- 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 404

Response Body - application/json

JSON object

Hide Sub-Attributes

error_codestring

RESOURCE_NOT_AVAILABLE: the specified templateId does not exist in the system

error_descriptionstring

Message indicating the configuration template was not found

Possible Response Codes

200HTTP code

401HTTP code

404HTTP code

Sample Response: HTTP 200

User-defined firewall configuration template details. Note: target data is NOT returned for this API (the service is invoked with cloneOption=WithoutTargets).

Copied!

  {
    "applyAtRefresh": false,
    "templateType": "userDefined",
    "modifiedUserName": "admin",
    "modifiedTime": "2026-03-20 14:25:00",
    "applyAlways": false,
    "description": "Standard firewall rules for Win11",
    "configType": "FIREWALL_RULES",
    "noOfRetries": 2,
    "platform": "windows",
    "isGlobalTemplate": false,
    "createdUserName": "admin",
    "configDetails": [
      {
        "configName": "FIREWALL_RULES",
        "details": {
          "protocol": "TCP",
          "port": 80,
          "ruleName": "Allow_HTTP"
        }
      }
    ],
    "enableNotification": false,
    "createdTime": "2026-03-15 10:00:00",
    "collectionId": 2001,
    "enableRefreshMinRetry": true,
    "email": "",
    "createdUserId": 2,
    "isUsedInConfig": true,
    "label": "Firewall_Template_v2",
    "targetModifiedBy": "admin",
    "applyAtStartupLogon": false,
    "refreshMinRetry": 1,
    "collectionType": 1,
    "targetModifiedTime": "2026-03-20 14:25:00",
    "enableLogonStartupMinRetry": true,
    "logonStartupMinRetry": 1,
    "createdFrom": 0,
    "modifiedUserId": 2,
    "schedulerSettings": {
      "enableInstallAfter": false,
      "enableExpiry": false
    },
    "enableRetry": true
  }

▼ Show full

System (pre-defined) Patch Install configuration template details. For pre-defined templates the audit fields (createdTime, modifiedTime, createdUserName, modifiedUserName, createdUserId, modifiedUserId) are NOT returned, and a tagName is included.

Copied!

  {
    "applyAtRefresh": false,
    "templateType": "preDefined",
    "applyAlways": false,
    "description": "",
    "label": "Default_Patch_Install_Template",
    "continueDeployment": true,
    "configType": "PATCH_INSTALL",
    "applyAtStartupLogon": false,
    "tagName": "PATCH_MANAGEMENT",
    "noOfRetries": 2,
    "refreshMinRetry": 1,
    "platform": "windows",
    "isGlobalTemplate": false,
    "collectionType": 1,
    "enableLogonStartupMinRetry": true,
    "logonStartupMinRetry": 1,
    "createdFrom": 0,
    "configDetails": [
      {
        "configName": "PATCH_INSTALL",
        "details": {}
      }
    ],
    "enableNotification": false,
    "collectionId": 1500,
    "enableRetry": true,
    "enableRefreshMinRetry": true,
    "email": ""
  }

▼ Show full

Sample Response: HTTP 401

User lacks read role for this config type or Patch_Registry_Read user accessing non-Patch template

Copied!

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

▼ Show full

Sample Response: HTTP 404

Template ID does not exist

Copied!

  {
    "error_description": "The requested configuration template 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.