Protocol version 3.0
The following example shows an HTTP request to scan a local file:
POST /api/v3.0/scanfile HTTP/1.0 Content-Type: application/octet-stream Content-Length: 22
{ "timeout": "10000", "object": "\/home\/user\/eicar" } |
For a description of all possible fields in the request body, see section "Format of a scan POST request". For recommendations on how to increase the detection rate, see section "Increasing the detection rate".
The following block shows the corresponding response:
HTTP/1.0 200 OK Connection: close Content-Type: text/plain Server: KAVHTTPD/1.0 X-KAV-ProtocolVersion: 3 Date: Wed, 30 Jan 2019 15:46:29 GMT Content-Length: 75
{ "object": "\/home\/user\/eicar", "scanResult": "DETECT", "detectionName": "EICAR-Test-File" } |
For description of all possible fields in the response body, see section "Format of a response to a scan POST request".
Protocol version 3.1
The format of the request is the same, but the response will have additional fields. For information about the additional response fields in KAV protocol version 3.1, see subsection "Additional fields in KAV protocol version 3.1" in section "Format of a response to a scan POST request".
Page top