This topic describes the status codes and response message returned by the ICAP service..
Status code overview
|
ICAP Status
|
HTTP Status
|
Description
|
Response Message
|
|
200 OK
|
N/A
|
ICAP capability negotiation
|
N/A
|
|
204 No Modifications
|
N/A
|
File is clean, no modifications needed
|
N/A
|
|
200 OK
|
400 Bad Request
|
Invalid or missing request data
|
See details below
|
|
200 OK
|
401 Unauthorized
|
Authentication failure
|
Varies by authentication error
|
|
200 OK
|
403 Forbidden
|
Malware detected in file
|
Virus Detected
|
|
405 Method Not Allowed
|
N/A
|
Unsupported ICAP method
|
N/A
|
|
200 OK
|
500 Internal Server Error
|
Scan error or system error
|
See details below
|
Success responses
200 OK (OPTIONS)
Standard ICAP handshake response. The client receives server capabilities including
supported methods and preview size.
204 No modifications
File scan completed successfully with no malware detected. The original file is passed
through unmodified.
Client error responses
400 Bad request
The request is missing required data for scan execution.
|
Message
|
Description
|
Unable to determine filename from header or URL |
The filename could not be determined from the
X-scan-file-name header or request URL. |
Response body is null |
The request does not contain a response body to scan.
|
401 Unauthorized
Authentication or authorization check failed. The response message varies based on
the specific authentication error.
403 Forbidden
Malware was detected in the scanned file.
|
Message
|
Description
|
Virus Detected |
The scan engine detected malicious content in the file. The original file is blocked.
|
405 Method not allowed
The ICAP method is not supported. Only
OPTIONS and RESPMOD methods are supported.Server error responses
500 Internal server error
Server errors are categorized into two types:
-
Scan errors (file-related)
-
System errors
Scan errors (file-related)
These errors occur when the scan engine cannot process the file.
|
Error Code
|
Message
|
Description
|
|
-69
|
Too many files in the zip. (-69)
|
The total count of file within archive exceed the limit.
|
|
-71
|
Maximum compression ratio exceeded. (-71)
|
The compress ratio exceed the limit.
|
|
-76
|
File is too large to extract. (-76)
|
The extracted file size exceeds the limit.
|
|
-78
|
Too many compressed layers (-78)
|
The total layers within archive exceed the limit.
|
|
-92
|
Cannot scan password protected files. (-92)
|
The file is password protected and cannot be scanned.
|
|
Other
|
Internal scan error ({code})
|
An unspecified scan error occurred.
|
Response format
The response includes a specific error description and error code:
{description} ({error_code})Example responses
Cannot scan password protected files. (-92)
Cannot scan password protected files. (-92); File is too large to extract. (-76)
System errors
These errors occur due to internal system issues unrelated to the file content.
|
Message
|
Description
|
Internal server error |
A system or infrastructure error occurred. Please retry the request. If the issue
persists, contact support.
|
Response format
All error responses are returned as HTML:
<html><body><h1>{error_message}</h1></body></html>The HTTP response includes:
-
Content-Type: text/html; charset=utf-8 -
Content-Length: {size}
