The Red Canary Application Programming Interface (API) can be leveraged to manage or query integrated external services. This feature currently supports AWS integration.
Accessing the API
- Click your user icon at the top right in your Red Canary, and select API.
- From the navigation menu, select External Services. You will find all available functions for interfacing with the External Services API in this section.
Using the API
The External Services API supports updating, deleting, querying, and creating new external services.
For example, to integrate a new AWS external service, use the Create AWS External Service function by making a POST call to /openapi/v3/external_services/aws.
The full path is: https://<subdomain>.my.redcanary.co/openapi/v3/external_services/aws.
For more details on other available functions, visit the API page.