Q: Are Create, Retrieve, Update and Delete operations available in the APIs or are they Read-Only?
A: API operations include (for certain endpoints): GET, POST, DELETE, PATCH.
Q: Do the API Retrieve operations allow for retrieval of records that have changed within a specific interval?
A: Retrieve operations for specific intervals are available for supported endpoints.
Q: If multiple changes have occurred to a record does the API allow retrieval of each of those records or just the most recent record? Do the records include timestamps of when the change occurred?
A: No. A single record (the most recent) is available. Changes are not reflected in the API, but audit log information is available via the API.
Q: Do the APIs enforce pre-set data validation rules during Create and Update operations to ensure data integrity?
A: Yes. Pre-set data validation rules on Create and Update operations exist.
Q: How do back-end (server) applications authenticate to the API? How do front-end (user) applications authenticate to the API?
A: Red Canary has one API. Authentication is completed using a per-Red Canary account API token.
A: No. Red Canary does not provide an SDK for the API.
Q: What are the API Rate Limits?
A: Per second rate limits are placed on the number of API requests you make per IP. To avoid rate limits, we recommend that you do not exceed both 20 requests per minute and 10 requests in one second.
If your IP address exceeds the rate limits, you will receive a response with an HTTP status code of 429 (Too Many Requests).