Getting Started with Red Canary REST API

Red Canary’s REST API makes it possible to extend functionality, is developer-friendly, and easily accessible.

You can find the REST API documentation in your Red Canary account, or by going to Open API.

1. Click your user icon at the top right in your Red Canary, and click API.

   

Generate an API Key

An API key or token—a secret phrase used like a password—provides an additional layer of security to your Red Canary account. This key should be changed periodically to maintain good security hygiene. If you suspect your key has been compromised, reset it immediately in Red Canary. This will revoke any existing key you've used before.

1. Click your user icon at the top right in your Red Canary, and select View profile.

   

2. Scroll to Generate API Authentication Token in the Security Settings section.

3. Click Generate. 

   

Note: Red Canary API keys are not set globally. API keys are generated and linked only to the individual user profile. Your API key will work with all Red Canary subdomains that are linked to your profile. Similarly, if you reset your API key, the key is no longer valid across subdomains you are linked to.

Find frequently asked API questions here.