Retrieve All Deployment Policies

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

Retrieves all deployment policies with platform information for the given customer.

Request URL

https://{serverurl}/dcapi/patch/deploymentPolicy

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/deploymentPolicy \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Array of deployment policy summary objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
templateIDlong

Unique identifier of the deployment policy template

templateNamestring

Name of the deployment policy template

templateDescstring

Description of the deployment policy template

templateInUseboolean

Whether this template is currently in use by any deployment

associatedModuleboolean

Whether this template is associated with a specific module

platformIdstring

Platform identifier: 1=Windows, 2=Mac, 3=Linux

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

List of deployment policies

Copied!
  {
    "deploymentPolicies": [
      {
        "templateInUse": true,
        "templateName": "My Deployment Policy",
        "associatedModule": false,
        "templateDesc": "Description",
        "platformId": 1,
        "templateID": 12345
      },
      {
        "templateInUse": false,
        "templateName": "Linux Patch Policy",
        "associatedModule": true,
        "templateDesc": "Policy for Linux servers",
        "platformId": 3,
        "templateID": 12346
      }
    ]
  }
                
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.