Creates a new deployment with the specified resources, targets, and execution schedule

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 persist the deployment

Request URL

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

Scope

DesktopCentralCloud.DEX.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/deploymentPersist.v2+jsonapplication/deploymentPersist.v2+jsonCopied!
AcceptstringMandatory
application/deploymentPersist.v2+jsonapplication/deploymentPersist.v2+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
deploymentNamestringOptional

Name for the new deployment

deploymentTypeintegerOptional

Deployment type code: 0=Immediate, 1=Scheduled, 2=Trigger. Fetch options from Get Deployment Types

resourcesDetailsJSON ArrayOptional

Resources to deploy

Show Sub-Attributes
JSON Object
Show Sub-Attributes
resourceTypeIDintegerOptional

Resource type identifier. Fetch from Get Deployment Resources

versionIDlongOptional

Resource version identifier. Fetch from Get Published Resources

targetDataJSON ObjectOptional

Target selection for the deployment

Show Sub-Attributes
includedJSON ArrayOptional

Included target custom groups

Show Sub-Attributes
JSON Object
Show Sub-Attributes
labelstringOptional

Display name of the target custom group

valuestringOptional

Custom group identifier. Fetch from Get Deployment Targets

executionDataJSON ObjectOptional

Execution scheduling configuration; empty object for immediate deployments

Show Sub-Attributes

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/intelligence/api/deployments/v2/persistDeployment \
  --header 'Accept: application/deploymentPersist.v2+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deploymentPersist.v2+json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "deploymentType": 0,
    "targetData": {
      "included": [
        {
          "label": "All Windows Devices",
          "value": "10"
        }
      ]
    },
    "resourcesDetails": [
      {
        "versionID": 1001,
        "resourceTypeID": 1
      }
    ],
    "deploymentName": "Onboarding Deployment",
    "executionData": {}
  }
                
Show full

Response Parameters

- HTTP code 202

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

Confirmation message including the created deployment name and id

Possible Response Codes

202HTTP code

Sample Response: HTTP 202

Copied!
  {
    "message": "Deployment 'Onboarding Deployment' created successfully with ID '42'."
  }
                
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.