# Initiate Patch Scan on Selected or All Computers Performs a patch scan on selected computers or all computers managed by the Endpoint Central server. **This API endpoint is deprecating soon** [View new endpoint >](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-scan-scan-systems.html) ## Endpoint `POST /api/1.4/patch/computers/scan` ## Request URL `https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/api/1.4/patch/computers/scan` ## Scope `DesktopCentralCloud.PatchMgmt.CREATE` #### Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Request Headers - **Content-Type** `string` — **Mandatory** — `application/json` - **Accept** `string` — **Mandatory** — `application/json` ### Query Parameters - **customerid** `long` — Optional Applicable only for MSP editions. A unique identifier of the customer on whom the action needs to be performed. Get the customer ID from the [Customer Details](https://www.manageengine.com/products/desktop-central/help/api/cloud/getallcustomers.html) API. ### Request Body `application/json` - `JSON Object` - **resourceids** `array` — Optional Resource IDs of the systems to scan. Get the resource IDs from the [Get All Systems](https://www.manageengine.com/products/desktop-central/help/api/cloud/system-report-legacy-get-all-systems.html) API. ### Sample Request ```curl curl --request POST \ --url https://appdomains/api/1.4/patch/computers/scan \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \ --header 'Content-Type: application/json' \ --data '{}' ``` ### Sample Request Body ```json { "resourceids": [ 112, 113 ] } ``` ## Response Parameters ### HTTP Code 200 Response Body — `application/json` - `JSON Object` - **message_type** `string` Value: `computers` - **message_response** `JSON Object` Scan initiation result - **message_version** `string` API version: `1.4` - **status** `string` Operation status: `success` ### HTTP Code 400 Response Body — `application/json` - `JSON Object` - **error_code** `string` Error code: `PATCH_SCAN_FAILED_CODE` for scan failures - **error** `string` Error type: `PATCH_SCAN_FAILED` - **error_description** `string` Detailed failure reason: invalid resources, no managed computers, or scan already in progress ### HTTP Code 401 Response Body — `application/json` - `JSON Object` - **errorCode** `long` Unauthorized error code returned when authentication credentials are missing, expired, or invalid (`authentication=required`) - **errorMsg** `string` Authentication failure reason ### HTTP Code 403 Response Body — `application/json` - `JSON Object` - **errorCode** `long` Forbidden error code returned when the authenticated user does not have the required uem-roles (for example, `DataEncryption_Admin` or `DataEncryptionRecoveryKey_Admin`) - **errorMsg** `string` Message indicating insufficient privileges to access this resource ### HTTP Code 429 Response Body — `application/json` - `JSON Object` - **errorCode** `long` Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes - **errorMsg** `string` Rate limit exceeded message with retry guidance ### Sample Response: HTTP 200 ```json { "message_type": "computers", "message_response": { "computers": { "status": "Scan initiated successfully" } }, "message_version": "1.4", "status": "success" } ``` ### Sample Response: HTTP 400 Resource IDs are invalid or not parseable ```json { "error_code": "PATCH_SCAN_FAILED_CODE", "error": "PATCH_SCAN_FAILED", "error_description": "Provided Resource list is not valid" } ``` Scan requires at least one resource ID ```json { "error_code": "PATCH_SCAN_FAILED_CODE", "error": "PATCH_SCAN_FAILED", "error_description": "Scan operation requires Resource ID." } ``` ### Sample Response: HTTP 401 Authentication credentials are missing, expired or invalid ```json { "error_code": "UAC_UNAUTHORIZED", "error_description": "dc.rest.authentication.unauthorized" } ``` ### Sample Response: HTTP 403 Authenticated user lacks the required role or scope ```json { "errorCode": "FORBIDDEN", "errorMessage": "You do not have sufficient privileges to perform this operation" } ``` ### Sample Response: HTTP 429 API call threshold exceeded ```json { "errorCode": "RATE_LIMIT_EXCEEDED", "errorMessage": "API call limit exceeded. Retry after the lock period elapses" } ``` ## Rate Limits ![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.