Fetches the full configuration details of a specific deployment

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

Used to get deployment data

Request URL

https://{serverurl}/intelligence/api/deployments/v2/{deploymentId}

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/getDeployment.v2+jsonapplication/getDeployment.v2+jsonCopied!

- Path Parameters

deploymentIdstringMandatory

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/api/deployments/v2/{deploymentId} \
  --header 'Accept: application/getDeployment.v2+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
deploymentDataJSON Object

Core deployment configuration

Show Sub-Attributes
detailsJSON Object

Deployment name and description

Show Sub-Attributes
namestring

Deployment name

descriptionstring

Deployment description

deploymentTypeinteger

Deployment type code: 0=Immediate, 1=Scheduled, 2=Trigger

targetDataJSON Object

Target selection for the deployment

Show Sub-Attributes
includedJSON Array

Included target custom groups

Show Sub-Attributes
JSON Object
Show Sub-Attributes
labelstring

Display name of the target custom group

valuestring

Custom group identifier. Fetch from Get Deployment Targets

resourcesDetailsJSON Array

Resources included in the deployment

Show Sub-Attributes
JSON Object
Show Sub-Attributes
resourceTypeIDinteger

Resource type identifier. Fetch from Get Deployment Resources

versionIDlong

Resource version identifier. Fetch from Get Published Resources

resourceNamestring

Name of the resource

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "targetData": {
      "included": [
        {
          "label": "All Windows Devices",
          "value": "10"
        }
      ]
    },
    "resourcesDetails": [
      {
        "versionID": 1001,
        "resourceTypeID": 1,
        "resourceName": "Onboarding Workflow"
      }
    ],
    "deploymentData": {
      "deploymentType": 0,
      "details": {
        "name": "Onboarding Deployment",
        "description": "Deploy onboarding workflow to all Windows devices"
      }
    }
  }
                
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.