Deployment status for a specified deploymentId

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 the deployment status for a specified deploymentId. To obtain the deploymentId, use the All Deployments API.

Request URL

https://{serverurl}/intelligence/api/deployments/EIDeploymentStatus Copied!

Scope

DesktopCentralCloud.dex.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

deploymentIDstringMandatory

Deployment ID

SEARCH_COLUMNstringOptional

Search Columns
The following columns are available for searching with their respective data types: Resource.NAME(String) ,Resource.DOMAIN_NETBIOS_NAME (String),BranchOfficeDetails.BRANCH_OFFICE_NAME (String),AgentContact.LOGGED_ON_USERS (String),EIManagedResource.AGENT_VERSION (String),ManagedComputer.FRIENDLY_NAME (String).

To search using a single column, provide one value in SEARCH_COLUMN and the corresponding value in SEARCH_VALUE.
Example:
SEARCH_COLUMN=Resource.NAME
SEARCH_VALUE=Device1

To search using multiple columns, provide comma-separated column names in SEARCH_COLUMN and the corresponding comma-separated values in SEARCH_VALUE in the same order.
Example:
SEARCH_COLUMN=Resource.NAME,OS_NAME
SEARCH_VALUE=Device1,Windows 11

Note: The number of values in SEARCH_VALUE must match the number of columns specified in SEARCH_COLUMN.

SEARCH_VALUEstringOptional

Search Values
Provide the search value(s) corresponding to the column(s) specified in the SEARCH_COLUMN parameter. Multiple values must be provided in the same order as the column names.

pagestringOptional

Page number

pageLimitstringOptional

Number of items per page

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/intelligence/api/deployments/EIDeploymentStatus?deploymentID=SOME_STRING_VALUE' \
  --header 'Accept: application/DexViewData.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Name of this view

totalRecordsstring

Total number of matching records

startIndexstring

Starting position of records in this page

noOfObjstring

Number of records in this page

dataJSON Array

List of per-device deployment status records

Show Sub-Attributes
JSON Object
Show Sub-Attributes
Resource.NAMEstring

Device name (masked for privacy)

Resource.DOMAIN_NETBIOS_NAMEstring

Domain of the device

BranchOfficeDetails.BRANCH_OFFICE_NAMEstring

Remote office location

EIDeploymentToResource.DEPLOYMENT_STATUSstring

Deployment status: 0 = Retry In Progress, 1 = Yet to Start, 2 = In Progress, 3 = Completed, 4 = Suspended, 5 = Failed

EIDeploymentToResource.REMARKSstring

Additional notes about the deployment

EIDeploymentRunDetails.RUN_TIMEstring

When the run occurred

EIDeploymentToResource.LAST_DEPLOYMENT_TIMEstring

When it was last deployed

EIManagedResource.AGENT_VERSIONstring

Version of the analytics agent

ManagedComputer.FRIENDLY_NAMEstring

Friendly name of the device

AgentContact.LAST_CONTACT_TIMEstring

When the device last contacted the server

AgentContact.LOGGED_ON_USERSstring

Users currently logged in

Sample Response: HTTP 200

Copied!
  {
    "viewName": "string",
    "totalRecords": "string",
    "startIndex": "string",
    "noOfObj": "string",
    "data": [
      {
        "Resource.NAME": "string",
        "Resource.DOMAIN_NETBIOS_NAME": "string",
        "BranchOfficeDetails.BRANCH_OFFICE_NAME": "string",
        "EIDeploymentToResource.DEPLOYMENT_STATUS": "string",
        "EIDeploymentToResource.REMARKS": "string",
        "EIDeploymentRunDetails.RUN_TIME": "string",
        "EIDeploymentToResource.LAST_DEPLOYMENT_TIME": "string",
        "EIManagedResource.AGENT_VERSION": "string",
        "ManagedComputer.FRIENDLY_NAME": "string",
        "AgentContact.LAST_CONTACT_TIME": "string",
        "AgentContact.LOGGED_ON_USERS": "string"
      }
    ]
  }
                
▼ 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.