Red Canary | Operate As Docs

Connect your client's Red Canary with a key they paste, and call its API through Operate As.

Website: redcanary.com
Connects by: Pasting a API key
Category: Developer tools
Services: 1
Tools: Pass-through only

Service	Key	Base URL
Red Canary	`red-canary`	`https://{subdomain}.my.redcanary.co/openapi/v3`

Your client also types their subdomain (The first part of your Red Canary address, such as acme in acme.my.redcanary.co).

Connecting

Your client makes a API key in their Red Canary settings and pastes it on their link. Operate As tries it with Red Canary before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "red-canary"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "red-canary"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the Red Canary key you paste, with only the access you gave that key	Chosen on the provider's screen

Pass-through

Red Canary has no ready-made tools yet. Call any endpoint of its API through Operate As instead, with the client's access attached.

Add the client

In Clients, add your client and select Red Canary. Then send them their link.

Your client connects

They paste a API key from their Red Canary settings.

Find the endpoint

Pick the call from Red Canary's own API docs. Your path is everything after https://{subdomain}.my.redcanary.co/openapi/v3, with the parts in braces filled in from your client's account.

Send it through Operate As

Use the client's ID, the service key red-canary and that path. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../red-canary/detections" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../red-canary/detections" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in Red Canary. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}