Python Canary API Wrapper

Thinkst Applied Research

Overview

The Python Canary API Wrapper allows access to the Canary Web API.

Installation

The API is supported on Python 2.7+, or 3.3+. The recommended way to install the API Wrapper is via pip.

pip install canarytools

For instructions on installing python and pip see "The Hitchhiker's Guide to Python" Installation Guides.

Quickstart

Assuming you have your API key handy as well as the domain of your website:

importcanarytoolsconsole=canarytools.Console(api_key='API_KEY', domain='CLIENT_DOMAIN')

Note: You can find your API key and domain on your console. Head over to the console's setup page and under Canary Console API you'll find your API key. Your domain is the tag in-front of 'canary.tools' in the console's url. For example in https://testconsole.canary.tools/settingstestconsole is the domain.

Alternatively, you can download a configurations file from the Canary Console API tab. Inside the file you'll find instructions on where to place it. If you have this on your system the api_key and domain parameters are no longer necessary when instantiating a Console object.

With the console instance you can then interact with a Canary Console:

# Get all devicesconsole.devices.all()
# Acknowledge all incidents for a device older than 3 daysconsole.incidents.acknowledge(node_id='329921d242c30b5e', older_than='3d')
# Iterate all devices and start the update processfordeviceinconsole.devices.all():
device.update(update_tag='4ae023bdf75f14c8f08548bf5130e861')
# Acknowledge and delete all host port scan Incidentsforincidentinconsole.incidents.unacknowledged():
ifisinstance(incident, canarytools.IncidentHostPortScan):
incident.acknowledge()
incident.delete()
# Create a web image Canarytokenconsole.tokens.create(
kind=canarytools.CanaryTokenKinds.KIND_WEB_IMAGE,
memo='Drop this token on DC box',
web_image='/path/to/test.png',
mimetype='image/png')
# Print out the name of all incidents and the source IP addressforincidentinconsole.incidents.all():
printincident.description, incident.src_host

Please see the API doc's documentation for more examples of what you can do with the Canary Console API.

Discussion and Support

Please file bugs and feature requests as issues on GitHub after first searching to ensure a similar issue was not already filed. If such an issue already exists please give it a thumbs up reaction. Comments to issues containing additional information are certainly welcome.

Documentation

The documentation is located at http://canarytools.readthedocs.io.

License

The Python Canary API Wrapper's source (v1.0.0+) is provided under the Revised BSD License.

• Copyright (c), 2025, Thinkst Applied Research