Trigger warranty scan for managed computers Initiates a bulk warranty scan for managed computers. Fetches the latest warranty information from configured vendors.
Request URL https://{server-hostname}:8383/dcapi/inventory/initiateWarrantyScan
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Content-Type string Mandatory
- Request Body application/json JSON Object
Hide Sub-Attributes scanType string Mandatory
Scan target. 0 - All devices, 1 - Expired devices only, 2 - Soon-to-expire devices only.
vendorID long Optional
Restricts scan to a specific vendor. Omit to scan across all configured vendors. 1 - Dell, 2 - Lenovo, 3 - Toshiba, 4 - HP
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
--url https://appdomain/dcapi/inventory/initiateWarrantyScan \
--header 'Accept: application/initiateWarrantyScanStatus.v1+json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/initiateWarrantyScanDetails.v1+json' \
--data '{"scanType":0}'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/inventory/initiateWarrantyScan"))
.header("Content-Type", "application/initiateWarrantyScanDetails.v1+json")
.header("Accept", "application/initiateWarrantyScanStatus.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"scanType\":0}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"scanType\":0}"
headers = {
'Content-Type': "application/initiateWarrantyScanDetails.v1+json",
'Accept': "application/initiateWarrantyScanStatus.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("POST", "/dcapi/inventory/initiateWarrantyScan", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Content-Type", "application/initiateWarrantyScanDetails.v1+json");
headersMap.put("Accept", "application/initiateWarrantyScanStatus.v1+json");
data=Map();
data.put("scanType","value");
data.put("vendorID","1");
response = invokeUrl
[
url: "https://appDomain/dcapi/inventory/initiateWarrantyScan"
type: POST
headers: headersMap
body: data
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Content-Type", "application/initiateWarrantyScanDetails.v1+json")
$headers.Add("Accept", "application/initiateWarrantyScanStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/inventory/initiateWarrantyScan' -Method POST -Headers $headers -ContentType 'application/initiateWarrantyScanDetails.v1+json' -Body '{"scanType":0}'Sample Request Body Scan all devices for any vendor
Copied!
{
"scanType": 0
}
▼ Show full
Scan only expired devices for a specific vendor
Copied!
{
"vendorID": 1,
"scanType": 1
}
▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes status string
Result - Success or Failure
statusMessage string
Human-readable result message
- HTTP code 401 Response Body - application/json JSON Object
Hide Sub-Attributes error_code string
UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing
error_description string
Authentication or authorization failure reason
- HTTP code 500 Response Body - application/json JSON Object
Hide Sub-Attributes error_code string
INTERNAL_ERROR - unexpected exception in the service layer
error_description string
Internal server error message
Possible Response Codes Sample Response: HTTP 200 {
"statusMessage": "Warranty scan has been initiated successfully.",
"status": "success"
}
▼ Show full
Sample Response: HTTP 401 {
"error_description": "Unauthorized access",
"error_code": "UAC_UNAUTHORIZED"
}
▼ Show full
Sample Response: HTTP 500 {
"error_description": "Internal server error",
"error_code": "INTERNAL_ERROR"
}
▼ 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.