Initiates a patch scan on specified systems to detect missing patches and vulnerabilities.
post /dcapi/patch/systems/scanSystems
https://{serverurl}/dcapi/patch/systems/scanSystems Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Resource IDs of the systems to scan; an empty array scans all managed systems (maximum 250 per call). Get the resource IDs from Get All Systems api
curl --request POST \
--url https://appdomains/dcapi/patch/systems/scanSystems \
--header 'Accept: application/scanSystems.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/scanSystems.v1+json' \
--data '{}' {
"systems": [
301,
302,
303
]
}
Scan state; inProgress while the scan is running
Human-readable result detail for the scan request
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
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
Rate limit exceeded message with retry guidance
{
"status": "inProgress",
"message": "Scan initiated successfully"
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
![]()
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.