Skip to main content

Cuckoo REST API client for Python.

Project description

cuckooapi

Client for Cuckoo’s REST API.

Installation Latest Version Coverage TravisCI

$ pip install cuckooapi

Usage example

>>> from cuckooapi import CuckooAPI
>>> api=CuckooAPI('http://cuckoohost:8090')
>>> response=api.cuckoo_status.get()
>>> response.data
{u'hostname': u'cuckoohost',
 u'machines': {u'available': 18, u'total': 18},
 u'tasks': {u'completed': 76,
  u'pending': 0,
  u'reported': 48268,
  u'running': 0,
  u'total': 48636},
 u'version': u'1.0-dev'}
>>> response.data['tasks']['pending']
0
>>> response.data['tasks']['running']
0

Endpoint Reference

https://github.com/cuckoobox/cuckoo/blob/master/docs/book/src/usage/api.rst

News

1.0.0

  • Endpoint list synced with current Cuckoo stable version (1.1).

0.0.1

  • Initial release.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page