# Integration Settings

Integrations are enhancements to your Console which tie into third-party systems.

# Fetch current integrations status

GET /api/v1/settings/integrations

Fetch the list of currently available integrations, and their status

Required Parameters

auth_token string
A valid auth token

Response

A JSON structure with result indicator.

Example

curl -X GET https://EXAMPLE.canary.tools/api/v1/settings/integrations \
  -d auth_token=EXAMPLE_AUTH_TOKEN 
Copied!
1
2
Response
{
  "integrations": {
    "rumble": true
  },
  "result":"success"}
}
Copied!
1
2
3
4
5
6

# Rumble integration

Rumble (opens new window) is an Asset Inventory product which provides additional information about attacker IPs. We integrate with Rumble, by providing an easy link from your Thinkst Canary Console to your Rumble Console. To make use of this integration, login into your Rumble Console, then click through from an incident in your Canary Console.

# Enable the Rumble integration

POST /api/v1/settings/integrations/rumble/enable

Enable the Rumble integration in the web interface. This is useful for customers of Thinkst Canary and Rumble.

Required Parameters

auth_token string
A valid auth token

Response

A JSON structure with result indicator.

Example

curl https://EXAMPLE.canary.tools/api/v1/settings/integrations/rumble/enable \
  -d auth_token=EXAMPLE_AUTH_TOKEN 
Copied!
1
2
Response
{
  "result": "success"
}
Copied!
1
2
3

# Disable the Rumble integration

POST /api/v1/settings/integrations/rumble/disable

Disables the Rumble integration.

Required Parameters

auth_token string
A valid auth token

Response

A JSON structure with result indicator.

Example

curl https://EXAMPLE.canary.tools/api/v1/settings/integrations/rumble/disable \
  -d auth_token=EXAMPLE_AUTH_TOKEN 
Copied!
1
2
Response
{
  "result": "success"
}
Copied!
1
2
3