Description: Enabling the API allows you to change Canary Configs, Manage Alerts, Mass Create Canarytokens, Manage Users, Create Flocks, and much much more (without even having to log in to your Console)! This covers Console-wide API access. For API access constrained to flocks, see here.
- Our API documentation can be found here
- We also have a bunch of scripts we've written on our GitHub page here
Note: Your Console and the API strictly support communicating using TLS 1.2 or higher. Attempting to query your Console with TLS 1.1 or lower will lead to a failure.
Follow the steps below to enable the API and generate an API token:
Log in to your Console.
Click on the Gear Icon and then Global Settings.
Click on API and Enable API from the menu.
You will need your Auth Token and Domain Hash when using the API - let's do a quick Ping Test to ensure everything is working - Ping Test found here
Auth Token is the API key that you'll need to use in order to make calls to your API.
Domain Hash is the unique hash identifying your Console when using the API.
We also maintain a Python wrapper for the API. The documentation for the Python wrapper is hosted here.