Returns the header-level overview for a deployment's detail page, including actions and tabs

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

Request URL

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

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

deploymentIdstringMandatory

Sample Request

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

Response Parameters

- HTTP code 200

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

Deployment header details

Show Sub-Attributes
detailsJSON Object

Deployment name and creation info

Show Sub-Attributes
namestring

Deployment name

createdTimestring

Formatted creation time

createdBystring

User who created the deployment

targetDataJSON Object

Target groups for the deployment

Show Sub-Attributes
includedJSON Array

Included target groups

Show Sub-Attributes
JSON Object
Show Sub-Attributes
groupNamestring

Name of the target custom group

cgResourceIdstring

Custom group resource identifier

actionsarray

Allowed actions for the current user (e.g., suspend, trash)

tabsJSON Array

Detail-page tabs to render

Show Sub-Attributes
JSON Object
Show Sub-Attributes
namestring

Internal tab identifier

displayNamestring

Tab display label

routestring

UI route for the tab

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "targetData": {
      "included": [
        {
          "groupName": "All Windows Devices",
          "cgResourceId": "10"
        }
      ]
    },
    "tabs": [
      {
        "route": "details.index",
        "displayName": "Summary",
        "name": "deployment-summary"
      },
      {
        "route": "details.deployment-status",
        "displayName": "Deployment Status",
        "name": "deployment-status"
      }
    ],
    "deploymentData": {
      "details": {
        "createdBy": "admin",
        "name": "Onboarding Deployment",
        "createdTime": "Apr 01, 2025 10:30 AM"
      }
    },
    "actions": [
      "suspend",
      "trash"
    ]
  }
                
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.