Canary API Docs

# Features

These are a collection of endpoints that allow you to obtain information about features that are enabled on your Console.

Endpoints
GET /api/v1/console/features

# Console Features

TIP

If you notice some features that aren't enabled but may interest you, contact support and we'll gladly explain and enable them for you.

GET /api/v1/console/features

Retrieves a list of enabled and disabled Console features.

Required Parameters

auth_token string
A valid auth token

Response

A JSON message with result indicator and list of Console features.

Example

curl https://EXAMPLE.canary.tools/api/v1/console/features \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -G

  
        Copied!
1
2
3
Response
{
  "features": {
    "adv_throttle_notifications": true,
    "apeeper_token": true,
    "awsidtoken": true,
    "awsidtoken_username": false,
    "azure_canary": false,
    "canary_firewall": false,
    "canary_smb_login": false,
    "canarytokens": true,
    "canaryvm": false,
    "cloud_canary": false,
    "console_api": true,
    "enable_auto_updates": false,
    "gcp_canary": false,
    "gdoc_factory_tokens": false,
    "globally_enforce_2fa": false,
    "http_token_whitelisting": false,
    "hyperv_canary": false,
    "incident_webhooks": true,
    "mask_notification_passwords": true,
    "new_ui": true,
    "office365_mail_token": true,
    "one_time_actions": true,
    "preserve_canaryvm_macs": true,
    "preserve_global_macs": false,
    "reset_endpoint": false,
    "rss_feeds": false,
    "saml": false,
    "skip_gateway_subnet_check": false,
    "slackapitoken": true,
    "snmp": false,
    "snmp_oid_whitelist": false,
    "ssh_credential_watches": false,
    "throttle_notifications": true,
    "tokenfactory": false,
    "webhook_hipchat": false,
    "whitelist_hostname": false,
    "whitelist_src_port": false
  },
  "result": "success"
}

  
        Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

← Global Search →