GET /api/v1/settings
# Overview
Console Settings endpoints will configure globally defined settings for your Console.
TIP
Flocks will, by default, inherit these settings, but you can individually configure a Flock's settings using the Flock Settings endpoints.
You can inspect all global settings using the Fetch Console Settings endpoint.
This will include global configuration for your API, Canarytokens, Ignore Lists, Integrations, Notification Channels, and Notification Settings.
Endpoints
# Fetch Console Settings
GET /api/v1/settings
Returns all global settings for a Console.
Required Parameters
auth_token string
A valid auth token
Response
JSON structure with all the global settings.
Example
Response
{
"auth_token": "<auth_token>",
"auth_token_enabled": true,
"canarytokens_user_domains_enable": false,
"canarytokens_webroot_enable": false,
"console_domain": "<console_domain>",
"console_settings_change_enable": false,
"device_settings_change_enable": false,
"email_notification_enable": true,
"generic_incident_webhooks": [
"<webhook_url>",
"<webhook_url>"
],
"globally_enforce_2fa": false,
"hipchat_integration_urls": [],
"incident_webhooks_enabled": true,
"module_options": {
"canarytokens_public_ip": "<ip_address>",
"canarytokens_user_domains": "",
"canarytokens_webroot": "<html><body>example!</body></html>",
"canaryvm_remaining_licenses": 10,
"canaryvm_version_details": [
{
"commit": "8a06e02",
"link": "<download_link>",
"ovalink": "<ova_link>",
"password": "<password>",
"seedlink": "<seed_link>",
"version": "2.2.1"
}
],
"saml_enabled": false,
"ssh_credential_watch_only": null,
"ssh_credential_watches": "",
"ssh_credential_watches_enable": null,
"update_automatically_enable": true
},
"ms_teams_webhooks": [],
"notification_addresses": [
"<email_address>"
],
"notification_numbers": [
"<cellphone_number>"
],
"result": "success",
"sensitive_data_masking_enable": false,
"slack_incident_webhook": [],
"sms_notification_enable": false,
"summary_email_addresses": [
"<email_address>"
],
"summary_email_enable": false,
"syslog_enabled": false,
"syslog_facility": "local0",
"syslog_hostname": "localhost",
"syslog_loglevel": "crit",
"syslog_port": "514",
"syslog_protocol": "tcp",
"syslog_tls": "off",
"whitelist_enable": true,
"whitelist_hostnames": "<hostname>",
"whitelist_hostnames_enable": true,
"whitelist_ips": "<ip_address>,<ip_address>",
"whitelist_oid_enable": false,
"whitelist_oids": "",
"whitelist_src_port_enable": true,
"whitelist_src_port_ips": "<ip_address>:<port>"
}
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68