Reference

Padawan service API

- Download the Python helper to use the API.

Endpoint Description
POST /submit Submit a sample for analysis.
POST /report Retrieve the analysis report for a sample.

POST /submit

Submit a sample for analysis. Requires a personal apikey.

Field Required? Description
apikey Yes Your personal API key.
file Yes The file to submit for analysis.
source No If you wish to tell us the origin of the sample.
public No If the analysis report will be public or private. It will be private by default.

The response will be a JSON with the following fields

JSON field Type Description
response_code Number -1 or 0. -1 if the submission had errors, 0 if the file was queued for analysis.
verbose_msg String Verbose message from the server. Error explanation if response_code is -1.
report_id String The report ID you can query to get the analysis results.
permalink String HTTP link to the report.

POST /report

Retrieve the analysis report for a sample. Requires a personal apikey.

Field Required? Description
apikey Yes Your personal API key.
name Yes The report_id of a sample. The same received from POST /submit.

The response will be a JSON with the following fields

JSON field Type Description
response_code Number -1 or 0. -1 if the report request had errors, 0 if the request was successful.
verbose_msg String Verbose message from the server. Error explanation if response_code is -1.
report String The final report. It can be loaded as a JSON.