Files
files
Request method: POST
Description: Returns a list of files in the system.
Additional payloads: Supports the Unified API query parameters.
This endpoint also supports quick searching for files by hashes, by using q=<hash>
instead of the aq
parameter of the Unified API Query:
/files?q=2a93e03b9e33dbca984dc06949a540d1
Output: data: {id, bytes, file_name, first_seen_as, md5sum, sha1, sha256, ssdeep, entropy, timestamp, first_seen, last_seen, mime_type}; extraPKValues; positionInTable: {offset}; logic
Response codes:
200 OK
- List of Files are returned
file-download
Request method: GET
Description: Downloads a file. A file ID must be supplied as a query parameter.
FIXTHIS
Response codes: __
200 OK
- File was found and binary returned
404 Not Found
- The file was not found
400 Bad Request
- There was an error with the request. See the JSON response for additional info.
file-download-hash
Request method: GET
Description: Downloads a file. A file hash must be supplied as a query parameter. /file-download-hash?hash=<md5, sha1, sha256, or sha512 hash>
Response codes:
200 OK
- File was found and binary returned
404 Not Found
- The file was not found
400 Bad Request
- There was an error with the request. See the JSON response for additional info.
files/single
Request method: GET
Description: Returns information about a single file. Must supply the file ID as a query parameter: /files/single?id=<file ID>
Output: data: {id, bytes, file_name, first_seen_as, md5sum, sha1, sha256, ssdeep, entropy, timestamp, first_seen, last_seen, mime_type}; extraPKValues; positionInTable: {offset}
Response codes:
200 OK
- File data was found and returned