Red Canary REST API v3

name: Red Canary REST API v3
description: Tenant-scoped REST API over the Red Canary portal. Documented resources include detections,
  threats, events, endpoints, endpoint_users, identities, investigations and audit_logs. Requests carry
  a per-user API token in the X-Api-Key header. Responses use a JSON:API-flavored envelope of meta / links
  / data, with page, per_page and direction pagination parameters. Rate limited to roughly 20 requests
  per minute and 10 requests per second per IP address.
humanURL: https://docs.redcanary.com/docs/red-canary-rest-api
baseURL: https://go.my.redcanary.co/openapi/v3/
x-base-url-template: https://<subdomain>.my.redcanary.co/openapi/v3/
tags:
- Security
- Threat Detection
- Endpoint Security
- Incident Response
properties:
- type: Documentation
  url: https://docs.redcanary.com/docs/red-canary-rest-api
- type: APIReference
  url: https://go.my.redcanary.co/openapi/v3/docs/index.html
- type: GettingStarted
  url: https://docs.redcanary.com/docs/red-canary-rest-api
- type: Authentication
  url: authentication/red-canary-authentication.yml
- type: ErrorCatalog
  url: errors/red-canary-problem-types.yml
- type: Conventions
  url: conventions/red-canary-conventions.yml
- type: DataModel
  url: data-model/red-canary-data-model.yml