REST API¶
To see the current hosted REST API documentation head to /apiv2/
. You will find all endpoints and details on how to do requests.
API example: https://capesandbox.com/apiv2/
To enable the REST API, we use django-rest-framework:
$ poetry run pip install djangorestframework
To generate a user authorization token:
# Ensure you are in CAPE's web directory
cd /opt/CAPEv2/web
# To create super user aka admin
python3 manage.py createsuperuser
# To create normal user, use web interface /admin/ (in case if you not changed path)
# By hand, only required if auth enabled and user MUST exist
python3 manage.py drf_create_token <your_user>
# Auto generation local or any public instance
curl -d "username=<USER>&password=<PASSWD>" http://127.0.0.1:8000/apiv2/api-token-auth/
curl -d "username=<USER>&password=<PASSWD>" https://capesandbox.com/apiv2/api-token-auth/
curl -d "username=<USER>&password=<PASSWD>" http(s)://<ANY_CAPE>/apiv2/api-token-auth/
# Usage
import requests
url = 'http://127.0.0.1:8000/apiv2/<ENDPOINT>'
headers = {'Authorization': 'Token <YOUR_TOKEN>'}
r = requests.get(url, headers=headers)
CAPE throttling, aka requests per minute/hour/day.¶
- Requires token authentication enabled in
api.conf
- Default 5/m
- You can change the default throttle limits in
api.conf
- To change the user limit go to django admin
/admin/
if you didn’t change the path, and set the limit per user in the user profile at the bottom.
Warning
All documentation below this warning is deprecated.
api.py DEPRECATED¶
Resources¶
Following is a list of currently available resources and a brief description of each one. For details click on the resource name.
Resource | Description |
---|---|
POST /tasks/create/file |
Adds a file to the list of pending tasks to be processed and analyzed. |
POST /tasks/create/url |
Adds an URL to the list of pending tasks to be processed and analyzed. |
GET /tasks/list |
Returns the list of tasks stored in the internal Cuckoo database. You can optionally specify a limit of entries to return. |
GET /tasks/view |
Returns the details on the task assigned to the specified ID. |
GET /tasks/delete |
Removes the given task from the database and deletes the results. |
GET /tasks/report |
Returns the report generated out of the analysis of the task associated with the specified ID. You can optionally specify which report format to return, if none is specified the JSON report will be returned. |
GET /tasks/screenshots |
Retrieves one or all screenshots associated with a given analysis task ID. |
GET /files/view |
Search the analyzed binaries by MD5 hash, SHA256 hash or internal ID (referenced by the tasks details). |
GET /files/get |
Returns the content of the binary with the specified SHA256 hash. |
GET /pcap/get |
Returns the content of the PCAP associated with the given task. |
GET /machines/list |
Returns the list of analysis machines available to Cuckoo. |
GET /machines/view |
Returns details on the analysis machine associated with the specified name. |
GET /cuckoo/status |
Returns the basic cuckoo status, including version and tasks overview |
/tasks/create/file¶
POST /tasks/create/file
Adds a file to the list of pending tasks. Returns the ID of the newly created task.
Example request:
curl -F file=@/path/to/file http://localhost:8090/tasks/create/fileExample request using Python:
import requests import json REST_URL = "http://localhost:8090/tasks/create/file" SAMPLE_FILE = "/path/to/malwr.exe" with open(SAMPLE_FILE, "rb") as sample: multipart_file = {"file": ("temp_file_name", sample)} request = requests.post(REST_URL, files=multipart_file) # Add your code to error checking for request.status_code. json_decoder = json.JSONDecoder() task_id = json_decoder.decode(request.text)["task_id"] # Add your code for error checking if task_id is None.Example response:
{ "task_id" : 1 }
- Form parameters:
file
(required) - sample file (multipart encoded file content)package
(optional) - analysis package to be used for the analysistimeout
(optional) (int) - analysis timeout (in seconds)priority
(optional) (int) - priority to assign to the task (1-3)options
(optional) - options to pass to the analysis packagemachine
(optional) - ID of the analysis machine to use for the analysisplatform
(optional) - name of the platform to select the analysis machine from (e.g. “windows”)tags
(optional) - define machine to start by tags. Platform must be set to use that. Tags are comma separatedcustom
(optional) - custom string to pass over the analysis and the processing/reporting modulesmemory
(optional) - enable the creation of a full memory dump of the analysis machineenforce_timeout
(optional) - enable to enforce the execution for the full timeout valueclock
(optional) - set virtual machine clock (format %m-%d-%Y %H:%M:%S)- Status codes:
200
- no error
/tasks/create/url¶
POST /tasks/create/url
Adds a file to the list of pending tasks. Returns the ID of the newly created task.
Example request:
curl -F url="http://www.malicious.site" http://localhost:8090/tasks/create/urlExample request using Python:
import requests import json REST_URL = "http://localhost:8090/tasks/create/url" SAMPLE_URL = "http://example.org/malwr.exe" multipart_url = {"url": ("", SAMPLE_URL)} request = requests.post(REST_URL, files=multipart_url) # Add your code to error checking for request.status_code. json_decoder = json.JSONDecoder() task_id = json_decoder.decode(request.text)["task_id"] # Add your code toerror checking if task_id is None.Example response:
{ "task_id" : 1 }
- Form parameters:
url
(required) - URL to analyze (multipart encoded content)package
(optional) - analysis package to be used for the analysistimeout
(optional) (int) - analysis timeout (in seconds)priority
(optional) (int) - priority to assign to the task (1-3)options
(optional) - options to pass to the analysis packagemachine
(optional) - ID of the analysis machine to use for the analysisplatform
(optional) - name of the platform to select the analysis machine from (e.g. “windows”)tags
(optional) - define machine to start by tags. Platform must be set to use that. Tags are comma separatedcustom
(optional) - custom string to pass over the analysis and the processing/reporting modulesmemory
(optional) - enable the creation of a full memory dump of the analysis machineenforce_timeout
(optional) - enable to enforce the execution for the full timeout valueclock
(optional) - set virtual machine clock (format %m-%d-%Y %H:%M:%S)- Status codes:
200
- no error
/tasks/list¶
GET /tasks/list/ (int: limit) / (int: offset)
Returns list of tasks.
Example request:
curl http://localhost:8090/tasks/listExample response:
{ "tasks": [ { "category": "url", "machine": null, "errors": [], "target": "http://www.malicious.site", "package": null, "sample_id": null, "guest": {}, "custom": null, "priority": 1, "platform": null, "options": null, "status": "pending", "enforce_timeout": false, "timeout": 0, "memory": false, "tags": [] "id": 1, "added_on": "2012-12-19 14:18:25", "completed_on": null }, { "category": "file", "machine": null, "errors": [], "target": "/tmp/malware.exe", "package": null, "sample_id": 1, "guest": {}, "custom": null, "priority": 1, "platform": null, "options": null, "status": "pending", "enforce_timeout": false, "timeout": 0, "memory": false, "tags": [ "32bit", "acrobat_6", ], "id": 2, "added_on": "2012-12-19 14:18:25", "completed_on": null } ] }
- Parameters:
limit
(optional) (int) - maximum number of returned tasksoffset
(optional) (int) - data offset- Status codes:
200
- no error
/tasks/view¶
GET /tasks/view/ (int: id)
Returns details on the task associated with the specified ID.
Example request:
curl http://localhost:8090/tasks/view/1Example response:
{ "task": { "category": "url", "machine": null, "errors": [], "target": "http://www.malicious.site", "package": null, "sample_id": null, "guest": {}, "custom": null, "priority": 1, "platform": null, "options": null, "status": "pending", "enforce_timeout": false, "timeout": 0, "memory": false, "tags": [ "32bit", "acrobat_6", ], "id": 1, "added_on": "2012-12-19 14:18:25", "completed_on": null } }
- Parameters:
id
(required) (int) - ID of the task to lookup- Status codes:
200
- no error404
- task not found
/tasks/delete¶
GET /tasks/delete/ (int: id)
Removes the given task from the database and deletes the results.
Example request:
curl http://localhost:8090/tasks/delete/1
- Parameters:
id
(required) (int) - ID of the task to delete- Status codes:
200
- no error404
- task not found500
- unable to delete the task
/tasks/report¶
GET /tasks/report/ (int: id) / (str: format)
Returns the report associated with the specified task ID.
Example request:
curl http://localhost:8090/tasks/report/1
- Parameters:
id
(required) (int) - ID of the task to get the report forformat
(optional) - format of the report to retrieve [json/html/maec/metadata/all/dropped]. If none is specified the JSON report will be returned.all
returns all the result files as tar.bz2,dropped
the dropped files as tar.bz2- Status codes:
200
- no error400
- invalid report format404
- report not found
/tasks/screenshots¶
GET /tasks/screenshots/ (int: id) / (str: number)
Returns one or all screenshots associated with the specified task ID.
Example request:
wget http://localhost:8090/tasks/screenshots/1
- Parameters:
id
(required) (int) - ID of the task to get the report forscreenshot
(optional) - numerical identifier of a single screenshot (e.g. 0001, 0002)- Status codes:
404
- file or folder not found
/files/view¶
GET /files/view/md5/ (str: md5)
GET /files/view/sha256/ (str: sha256)
GET /files/view/id/ (int: id)
Returns details on the file matching either the specified MD5 hash, SHA256 hash or ID.
Example request:
curl http://localhost:8090/files/view/id/1Example response:
{ "sample": { "sha1": "da39a3ee5e6b4b0d3255bfef95601890afd80709", "file_type": "empty", "file_size": 0, "crc32": "00000000", "ssdeep": "3::", "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "sha512": "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e", "id": 1, "md5": "d41d8cd98f00b204e9800998ecf8427e" } }
- Parameters:
md5
(optional) - MD5 hash of the file to lookupsha256
(optional) - SHA256 hash of the file to lookupid
(optional) (int) - ID of the file to lookup- Status codes:
200
- no error400
- invalid lookup term404
- file not found
/files/get¶
GET /files/get/ (str: sha256)
Returns the binary content of the file matching the specified SHA256 hash.Example request:
curl http://localhost:8090/files/get/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 > sample.exe
- Status codes:
200
- no error404
- file not found
/pcap/get¶
GET /pcap/get/ (int: task)
Returns the content of the PCAP associated with the given task.
Example request:
curl http://localhost:8090/pcap/get/1 > dump.pcap
- Status codes:
200
- no error404
- file not found
/machines/list¶
GET /machines/list
Returns a list with details on the analysis machines available to Cuckoo.
Example request:
curl http://localhost:8090/machines/listExample response:
{ "machines": [ { "status": null, "locked": false, "name": "cuckoo1", "resultserver_ip": "192.168.56.1", "ip": "192.168.56.101", "tags": [ "32bit", "acrobat_6", ], "label": "cuckoo1", "locked_changed_on": null, "platform": "windows", "snapshot": null, "interface": null, "status_changed_on": null, "id": 1, "resultserver_port": "2042" } ] }
- Status codes:
200
- no error
/machines/view¶
GET /machines/view/ (str: name)
Returns details on the analysis machine associated with the given name.
Example request:
curl http://localhost:8090/machines/view/cuckoo1Example response:
{ "machine": { "status": null, "locked": false, "name": "cuckoo1", "resultserver_ip": "192.168.56.1", "ip": "192.168.56.101", "tags": [ "32bit", "acrobat_6", ], "label": "cuckoo1", "locked_changed_on": null, "platform": "windows", "snapshot": null, "interface": null, "status_changed_on": null, "id": 1, "resultserver_port": "2042" } }
- Status codes:
200
- no error404
- machine not found
/cuckoo/status¶
GET /cuckoo/status/
Returns status of the cuckoo server.
Example request:
curl http://localhost:8090/cuckoo/statusExample response:
{ "tasks": { "reported": 165, "running": 2, "total": 167, "completed": 0, "pending": 0 }, "version": "1.0", "protocol_version": 1, "hostname": "Patient0", "machines": { "available": 4, "total": 5 } "tools":["vanilla"] }
- Status codes:
200
- no error404
- machine not found