Initiate Patch Scan on Selected or All Computers Deprecating soon

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

Performs a patch scan on selected computers or all computers managed by the Endpoint Central server.

This API endpoint is deprecating soon

Request URL

https://{serverurl}/api/1.4/patch/computers/scan

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

customeridlongOptional

- Request Body

application/json
JSON Object
Hide Sub-Attributes
resourceidsarrayOptional

List of resource IDs to scan. If empty, scans all systems.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/api/1.4/patch/computers/scan \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'

Sample Request Body

Scan selected computers by resource IDs

Copied!
  {
    "resourceids": [
      301,
      302,
      303
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

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

Action identifier: computers

message_responseJSON Object

Response payload containing scan result

Show Sub-Attributes
computersJSON Object

Scan status object

Show Sub-Attributes
statusstring

Scan operation result message (e.g., Scan initiated successfully)

message_versionstring

API version string (e.g., 1.4)

statusstring

Overall operation status: success

- HTTP code 400

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

Error code: PATCH_SCAN_FAILED_CODE for scan failures

errorstring

Error type: PATCH_SCAN_FAILED

error_descriptionstring

Detailed failure reason: invalid resources, no managed computers, or scan already in progress

Possible Response Codes

200HTTP code
400HTTP code

Sample Response: HTTP 200

Scan started for selected systems

Copied!
  {
    "message_type": "computers",
    "message_response": {
      "computers": {
        "status": "Scan initiated successfully"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 400

Resource IDs are invalid or not parseable

Copied!
  {
    "error_description": "Provided Resource list is not valid",
    "error_code": "PATCH_SCAN_FAILED_CODE",
    "error": "PATCH_SCAN_FAILED"
  }
                
Show full

Scan requires at least one resource ID

Copied!
  {
    "error_description": "Scan operation requires Resource ID.",
    "error_code": "PATCH_SCAN_FAILED_CODE",
    "error": "PATCH_SCAN_FAILED"
  }
                
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.