Retrieve a list of configuration templates

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 a paginated list of available configuration templates. Supports optional filtering by template name using a search keyword, and pagination via offset and limit parameters.

Request URL

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

Scope

DesktopCentralCloud.Configurations.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

searchValuestringOptional

Search keyword to filter templates by name.

offsetintegerOptional

Starting index for pagination. Default is 0.

limitstringOptional

Maximum number of templates to return per page.

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
templatesJSON Array

Array of template summary objects matching the filter criteria

Show Sub-Attributes
JSON Object
Show Sub-Attributes
templateIdlong

The unique template ID

templateNamestring

Display name of the template

configTypestring

Configuration type name such as Firewall, BrowserConfig, CustomScript

platformstring

Target platform — Windows, Mac, or Linux

createdBystring

Username of the template creator

createdTimestring

Timestamp of template creation

totalCountstring

Total number of templates matching the search criteria

- 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

Possible Response Codes

200HTTP code
401HTTP code

Sample Response: HTTP 200

Paginated list of configuration templates

Copied!
  {
    "templates": [
      {
        "templateName": "Firewall_Policy_Template",
        "createdBy": "admin",
        "createdTime": "2026-03-15 10:00:00",
        "templateId": 1001,
        "configType": "Firewall",
        "platform": "Windows"
      },
      {
        "templateName": "Chrome_Settings_Template",
        "createdBy": "admin",
        "createdTime": "2026-03-16 11:30:00",
        "templateId": 1002,
        "configType": "BrowserConfig",
        "platform": "Windows"
      }
    ],
    "totalCount": 25
  }
                
Show full

Sample Response: HTTP 401

User lacks read role

Copied!
  {
    "error_description": "Access denied - You are not allowed to access the requested resource.",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
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.