checkHash
- Print
- PDF
checkHash
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Use hash values to check a file or URL string for maliciousness with hash filter.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /checkHash |
Request headers
For information about the headers common to all File Safer APIs, see Common File Safer API headers.
Request query parameters
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
hashCode | String | Required | Hash value to query |
hashType | String | Required | Algorithm used to create the hash value to query
|
Request example
The request example is as follows:
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
returnCode | String | Required | Processing result code for the request |
returnMessage | String | Required | Processing result message for the request |
totalRows | Integer | Required | Number of objects for hashCheckResultList |
hashCheckResultList[] | Array | Required | Detection results for the hash value queried
|
hashCheckResultList[].hashType | String | Conditional | Algorithm used to create hashCode
|
hashCheckResultList[].hashCode | String | Conditional | Hash value detected as malware
|
hashCheckResultList[].group | String | Conditional | Type of hash value detected as malware
|
hashCheckResultList[].result | String | Conditional | Whether the hash value queried was detected as malware
|
hashCheckResultList[].regDatetime | Long | Conditional | Time the hash value was registered
|
Response status codes
For information about the HTTP status codes common to all File Safer APIs, see File Safer response status codes.
Response example
The response example is as follows:
If malware is detected
The following is a sample response if malware is detected.
If malware is not detected
The following is a sample response if malware is not detected.
Was this article helpful?