List the Windows services available for a Services template.

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 every Windows service that can be referenced in a Services template, covering both the predefined services shipped with the product and services added for this customer. Use the serviceName and displayName from this response when building the Services template payload.

Request URL

https://{serverurl}/dcapi/configuration/windows/services Copied!

Scope

DesktopCentralCloud.Configurations.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Versioned media type of the response body, as produced by the endpoint.

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

One Windows service that can be referenced in a Services configuration policy.

Hide Sub-Attributes
serviceIDlong

Unique identifier of the service entry in the repository.

serviceNamestring

Internal Windows service name. Pass this value as serviceName in the Services configuration payload.

displayNamestring

Human-readable name of the service. Localised for predefined services. Pass this value as displayName in the Services configuration payload.

descriptionstring

What the service does. Localised for predefined services.

inputTypeinteger

Origin of the entry. Allowed values:
1 = defined for this customer
2 = predefined and shipped with the product

Entries with inputType 1 are returned only for the customer that owns them.

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

Response Body - application/json
JSON Object

Error response when the Windows services list cannot be read.

Hide Sub-Attributes
errorCodelong

Product error code. 50001 = CONFIG_INTERNAL_ERROR: the services repository could not be queried.

errorMsgstring

Localised error message for the error code.

Sample Response: HTTP 200

A predefined service followed by a customer-defined one

Copied!
  [
    {
      "displayName": "Windows Update",
      "description": "Enables the detection, download, and installation of updates.",
      "inputType": 2,
      "serviceID": 1,
      "serviceName": "wuauserv"
    },
    {
      "displayName": "My Custom Service",
      "description": "Custom service added for this customer.",
      "inputType": 1,
      "serviceID": 25,
      "serviceName": "MyCustomService"
    }
  ]
                
▼ Show full

Sample Response: HTTP 401

User is not authorized to list Windows services

Copied!
  {
    "errorCode": 1001,
    "errorMsg": "Access denied - You are not allowed to access the requested resource."
  }
                
▼ Show full

Sample Response: HTTP 500

Server error while reading the services list

Copied!
  {
    "errorCode": 50001,
    "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.