Returns the full detail summary for a deployment, including status, mode, and scheduling information

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 details data for the deployment id

Request URL

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

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

deploymentIdstringMandatory

Sample Request

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

Response Parameters

- HTTP code 200

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

Deployment detail summary and columns

Show Sub-Attributes
detailsJSON Object

Full deployment detail fields

Show Sub-Attributes
namestring

Deployment name

descriptionstring

Deployment description

statusJSON Object

Deployment status code and remark

Show Sub-Attributes
codeinteger

Status code of the deployment

remarkstring

Human-readable status remark (e.g., Active)

modestring

Deployment mode (e.g., Immediate)

createdTimestring

Formatted creation time

createdBystring

User who created the deployment

lastModifiedTimestring

Formatted last-modified time

lastModifiedBystring

User who last modified the deployment

columnsJSON Array

Column definitions for the detail table

Show Sub-Attributes
JSON Object
Show Sub-Attributes
keyJSON Object

Column key metadata

Show Sub-Attributes
namestring

Column field name

displayNamestring

Column display label

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "deploymentData": {
      "columns": [
        {
          "key": {
            "displayName": "Name",
            "name": "name"
          }
        },
        {
          "key": {
            "displayName": "Status",
            "name": "status"
          }
        },
        {
          "key": {
            "displayName": "Deployment Type",
            "name": "mode"
          }
        },
        {
          "key": {
            "displayName": "Created At",
            "name": "createdTime"
          }
        },
        {
          "key": {
            "displayName": "Created By",
            "name": "createdBy"
          }
        }
      ],
      "details": {
        "mode": "Immediate",
        "lastModifiedTime": "Apr 05, 2025 02:15 PM",
        "createdBy": "admin",
        "lastModifiedBy": "admin",
        "name": "Onboarding Deployment",
        "description": "Deploy onboarding workflow to all Windows devices",
        "createdTime": "Apr 01, 2025 10:30 AM",
        "status": {
          "code": 1,
          "remark": "Active"
        }
      }
    }
  }
                
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.