Initiate Patch Scan for All Systems

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 a patch scan across all computers managed by the Endpoint Central server.

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

customeridlongOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/api/1.4/patch/computers/scanall \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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 initiated for all managed computers

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

Sample Response: HTTP 400

No managed computers found for user

Copied!
  {
    "error_description": "Verify if the specified resources can be managed by this user or the resource scan status is already in in-progress state",
    "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.