List all deployments

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

Return All Deployments created. To get sensor object and version IDs use Get Sensor Details. To get workflow object and version IDs use Get workflow Details.In api response module_object_id - The object ID of the deployed resource. module_object_version_id - The version ID of the deployed resource.

Request URL

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

Scope

DesktopCentralCloud.dex.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

SEARCH_COLUMNstringOptional

Search Columns
The following columns are available for searching with their respective data types: EIDeployment.DEPLOYMENT_NAME(String).

To search using a single column, provide one value in SEARCH_COLUMN and the corresponding value in SEARCH_VALUE.
Example:
SEARCH_COLUMN=EIDeployment.DEPLOYMENT_NAME
SEARCH_VALUE=Deployment1

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.

objectIDstringOptional

Object ID

objectVersionIDstringOptional

Object version ID

objectTypestringOptional

Object type

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/EIAllDeploymentsView \
  --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 deployment records

Show Sub-Attributes
JSON Object
Show Sub-Attributes
EIDeployment.DEPLOYMENT_NAMEstring

Deployment name

EIDeployment.DEPLOYMENT_TYPEstring

Type of deployment

EIDeployment.CREATED_BYstring

User who created it

EIDeployment.CREATED_TIMEstring

Date and time when it was created

EIDeployment.DEPLOYMENT_STATUSstring

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

EIDeployment.REMARKSstring

Additional notes about the deployment

EIDeployment.LAST_MODIFIED_BYstring

User who last modified it

EIDeployment.MODIFIED_TIMEstring

Date and time of the last modification

EIDeployment.SUSPENDED_BYstring

User who suspended the deployment

EIDeployment.SUSPENDED_TIMEstring

When the deployment was suspended

Sample Response: HTTP 200

Copied!
  {
    "viewName": "string",
    "totalRecords": "string",
    "startIndex": "string",
    "noOfObj": "string",
    "data": [
      {
        "EIDeployment.DEPLOYMENT_NAME": "string",
        "EIDeployment.DEPLOYMENT_TYPE": "string",
        "EIDeployment.CREATED_BY": "string",
        "EIDeployment.CREATED_TIME": "string",
        "EIDeployment.DEPLOYMENT_STATUS": "string",
        "EIDeployment.REMARKS": "string",
        "EIDeployment.LAST_MODIFIED_BY": "string",
        "EIDeployment.MODIFIED_TIME": "string",
        "EIDeployment.SUSPENDED_BY": "string",
        "EIDeployment.SUSPENDED_TIME": "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.