Initiate MDM profile installation on computers

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

Initiates an MDM profile installation request on one or more computers.

Request URL

https://{serverurl}/dcapi/som/computers/actionRequest/mdm-profile/install

Scope

DesktopCentralCloud.SOM.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/computerIdsToInstallMDM.v1+jsonapplication/computerIdsToInstallMDM.v1+jsonCopied!
AcceptstringMandatory
application/mdmProfileInstallationStatus.v1+jsonapplication/mdmProfileInstallationStatus.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
computerIDsarrayOptional

Array of computer resource IDs to perform the operation, get computer IDs from the response of the Computers API, under the resource_id field.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/som/computers/actionRequest/mdm-profile/install \
  --header 'Accept: application/mdmProfileInstallationStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/computerIdsToInstallMDM.v1+json' \
  --data '{}'

Sample Request Body

Install MDM profile on computers

Copied!
  {
    "computerIDs": [
      2001,
      2002
    ]
  }
                
Show full

Response Parameters

- HTTP code 202

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

Array of computer resource IDs originally submitted in the MDM profile installation request

statusboolean

Indicates whether the MDM profile installation request was accepted and initiated successfully

messagestring

Descriptive message providing details about the installation outcome or any errors encountered

actionRequestIDstring

Unique tracking identifier for this action request. Use this ID to poll status

selectedComputersCountstring

Total number of computers selected by the user for MDM profile installation

applicableComputersCountstring

Number of computers that meet the prerequisites for MDM profile installation

notApplicableComputersCountstring

Number of computers that do not meet the prerequisites for MDM profile installation (e.g., unsupported OS)

successComputersCountstring

Number of computers where the MDM profile installation was successfully initiated

failureComputersCountstring

Number of computers where the MDM profile installation could not be initiated (e.g., agent offline, pre-check failed)

mdmEnrollmentInProgressboolean

Indicates whether the MDM enrollment process is currently running across the selected computers

requestedComputersarray

Array of computer resource IDs that were processed for MDM profile installation

- HTTP code 400

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

HTTP status code (400)

errorCodestring

API-specific error code identifying the validation failure

messagestring

Error message describing the validation failure

- HTTP code 412

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

HTTP status code (412)

errorCodestring

Precondition failed error code identifying the business logic violation

messagestring

Error message describing the precondition failed while processing request

Possible Response Codes

202HTTP code
400HTTP code
412HTTP code

Sample Response: HTTP 202

MDM profile install initiated

Copied!
  {
    "computerIDs": [
      2001,
      2002
    ],
    "applicableComputersCount": 2,
    "notApplicableComputersCount": 0,
    "failureComputersCount": 0,
    "mdmEnrollmentInProgress": true,
    "message": "",
    "selectedComputersCount": 2,
    "successComputersCount": 0,
    "actionRequestID": "AR-MDM-1712567890123",
    "requestedComputers": [
      2001,
      2002
    ],
    "status": true
  }
                
Show full

Sample Response: HTTP 400

Missing or empty computerIDs in request

Copied!
  {
    "errorCode": "20006",
    "message": "Resource IDs are not present in the request",
    "statusCode": 400
  }
                
Show full

Sample Response: HTTP 412

Non-admin user cannot access the requested computers

Copied!
  {
    "errorCode": "20005",
    "message": "Selected computers are not accessible",
    "statusCode": 412
  }
                
Show full

Some computers are not managed by the server

Copied!
  {
    "errorCode": "30007",
    "message": "All resources are not managed computers",
    "statusCode": 412
  }
                
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.