List of Endpoints

We've included a full list of available endpoints below for completeness.

• /api/v1/bundle/cancel
• /api/v1/bundle/info
• /api/v1/bundles/list
• /api/v1/bundles/list/all
• /api/v1/containercanary/images
• /api/v1/device/reboot
• /api/v1/device/update
• /api/v1/device/notifications/disconnects/disable
• /api/v1/device/notifications/disconnects/enable
• /api/v1/device/notifications/incidents/disable
• /api/v1/device/notifications/incidents/enable
• /api/v1/device/notifications/reconnects/disable
• /api/v1/device/notifications/reconnects/enable
• /api/v1/cloudcanary/images
• /api/v1/device/note
• /api/v1/device/note/add
• /api/v1/device/note/delete
• /api/v1/incidents/outside_bird/summary
• /api/v1/incidents/outside_bird/services/count
• /api/v1/incidents/outside_bird/search
• /api/v1/incident/outside_bird/delete
• /api/v1/incidents/outside_bird/delete
• /api/v1/device/outside_bird/enable
• /api/v1/device/outside_bird/disable
• /api/v1/incidents/outside_bird/download/json
• /api/v1/device/outside_bird/webhooks
• /api/v1/device/outside_bird/webhooks/add
• /api/v1/device/outside_bird/webhooks/remove
• /api/v1/device/outside_bird/webhooks/test
• /api/v1/personalities/list
• /api/v1/personalities/delete
• /api/v1/device/custompersonality/exists
• /api/v1/devices/all
• /api/v1/devices/live
• /api/v1/devices/dead
• /api/v1/devices/filter
• /api/v1/device/info
• /api/v1/device/ips
• /api/v1/device/configure
• /api/v1/device/configure_personality
• /api/v1/shareupload/end
• /api/v1/shareupload/start
• /api/v1/shareupload/status
• /api/v1/webrootupload/end
• /api/v1/webrootupload/start
• /api/v1/webrootupload/status
• /api/v1/canaryvm/download
• /api/v1/canaryvm/downloadseed
• /api/v1/hypervcanary/download
• /api/v1/hypervcanary/downloadseed
• /api/v1/update/fetch
• /api/v1/update/updatable_birds
• /api/v1/update/updating_devices
• /api/v1/updates/list
• /api/v1/breadcrumb/generate
• /api/v1/breadcrumb/download
• /api/v1/canarytokens/clonedsite/ignorelist/disable
• /api/v1/canarytokens/clonedsite/ignorelist/enable
• /api/v1/canarytokens/clonedsite/ignorelist/fetch
• /api/v1/canarytokens/clonedsite/ignorelist/save
• /api/v1/canarytokens/list
• /api/v1/canarytokens/paginate
• /api/v1/apeeperfactory/delete
• /api/v1/canarytoken/create
• /api/v1/canarytoken/delete
• /api/v1/canarytokens/delete
• /api/v1/canarytoken/disable
• /api/v1/canarytoken/download
• /api/v1/canarytoken/enable
• /api/v1/canarytoken/fetch
• /api/v1/canarytoken/remove/s3
• /api/v1/canarytoken/update
• /api/v1/canarytoken/update/redirect_url
• /api/v1/canarytokens/factory/list
• /api/v1/canarytoken/create_factory
• /api/v1/canarytoken/delete_factory
• /api/v1/canarytoken/list_factories
• /api/v1/canarytoken/factory/create
• /api/v1/canarytoken/factory/download
• /api/v1/canarytoken/gmail/users/list
• /api/v1/canarytoken/gmail/create
• /api/v1/canarytoken/gmail/email
• /api/v1/canarytoken/gmail/email
• /api/v1/canarytoken/gmail/status
• /api/v1/canarytoken/factorydoc/generate
• /api/v1/canarytoken/factorydoc/sharehistory
• /api/v1/canarytoken/registerdoc
• /api/v1/canarytokens/fetch
• /api/v1/canarytokens/paginate
• /api/v1/canarytokens/search
• /api/v1/canarytoken/office365/initiate
• /api/v1/canarytoken/office365/users/list
• /api/v1/canarytoken/office365/create
• /api/v1/canarytoken/office365/email
• /api/v1/canarytoken/office365/email
• /api/v1/canarytoken/office365/oauth/token
• /api/v1/canarytoken/office365/status
• /api/v1/devices/commission/pending
• /api/v1/device/cancel_commission
• /api/v1/device/commission
• /api/v1/device/decommission
• /api/v1/settings/api/disable
• /api/v1/settings/api/enable
• /api/v1/auth_token/add
• /api/v1/auth_token/list
• /api/v1/auth_token/download
• /api/v1/auth_token/remove
• /api/v1/settings/ignore_hostnames
• /api/v1/settings/ignore_hostnames/disable
• /api/v1/settings/ignore_hostnames/enable
• /api/v1/settings/ignorelist_src_port
• /api/v1/settings/ignorelist_src_port/disable
• /api/v1/settings/ignorelist_src_port/enable
• /api/v1/settings/is_hostname_whitelisted
• /api/v1/settings/is_ip_ignored
• /api/v1/settings/whitelist_ip_port
• /api/v1/settings/whitelisting/disable
• /api/v1/settings/whitelisting/enable
• /api/v1/settings/whitelisting/remove_whitelist_ip
• /api/v1/settings/whitelisting/whitelist_ips
• /api/v1/settings/ignored_annotations/disable
• /api/v1/settings/ignored_annotations/enable
• /api/v1/settings/ignored_annotations/ignore
• /api/v1/settings/ignored_annotations/remove
• /api/v1/settings/ignored_annotations
• /api/v1/settings/ignored_annotations/is_annotation_ignored
• /api/v1/settings/ignored_annotations/incidents/count
• /api/v1/settings/ignored_annotations/incidents
• /api/v1/settings/notifications/email/disable
• /api/v1/settings/notifications/email/enable
• /api/v1/settings/notifications/email/save
• /api/v1/settings/notifications/operational_email/disable
• /api/v1/settings/notifications/operational_email/enable
• /api/v1/settings/notifications/operational_email/save
• /api/v1/settings/notifications/info
• /api/v1/settings/notifications/sms/disable
• /api/v1/settings/notifications/sms/enable
• /api/v1/settings/notifications/sms/save
• /api/v1/settings/generic/list
• /api/v1/settings/generic/add
• /api/v1/settings/generic/remove
• /api/v1/settings/generic/test
• /api/v1/settings/ms_teams/add
• /api/v1/settings/ms_teams/remove
• /api/v1/settings/ms_teams/test
• /api/v1/settings/slack/remove
• /api/v1/settings/slack/test
• /api/v1/pubsub/new_subscription
• /api/v1/pubsub/remove_subscription
• /api/v1/pubsub/test
• /api/v1/settings/console_settings_change/disable
• /api/v1/settings/console_settings_change/enable
• /api/v1/settings/device_settings_change/disable
• /api/v1/settings/device_settings_change/enable
• /api/v1/settings/notifications/masking/disable
• /api/v1/settings/notifications/masking/enable
• /api/v1/settings/notifications/summary_email/disable
• /api/v1/settings/notifications/summary_email/enable
• /api/v1/settings/notifications/summary_email/save
• /api/v1/settings/canarytokens/user_domains/disable
• /api/v1/settings/canarytokens/user_domains/enable
• /api/v1/settings/canarytokens/user_domains/save
• /api/v1/settings/canarytokens/webroot/disable
• /api/v1/settings/canarytokens/webroot/enable
• /api/v1/settings/canarytokens/webroot/save
• /api/v1/settings/integrations
• /api/v1/settings/integrations/rumble/enable
• /api/v1/settings/integrations/rumble/disable
• /api/v1/console/features
• /api/v1/audit_trail/fetch
• /api/v1/audit_trail/purge
• /api/v1/audit_trail/download/json
• /api/v1/license/detailed/info
• /api/v1/settings
• /api/v1/global/search
• /api/v1/ping
• /api/v1/syslog/fake_alert/<incident_count>
• /api/v1/syslog/test
• /api/v1/flock/settings/devices/autocommission/enable
• /api/v1/flock/settings/devices/autocommission/disable
• /api/v1/flock/settings/devices/autocommission/token
• /api/v1/flock/settings/devices/autocommission/generate
• /api/v1/flock/settings/devices/autocommission/remove_token
• /api/v1/flock/settings/change_control/flock_settings/disable
• /api/v1/flock/settings/change_control/flock_settings/enable
• /api/v1/flock/settings/change_control/flock_settings/is_enabled
• /api/v1/flock/settings/change_control/flock_settings/is_global
• /api/v1/flock/settings/change_control/flock_settings/use_global
• /api/v1/flock/settings/change_control/device_settings/disable
• /api/v1/flock/settings/change_control/device_settings/enable
• /api/v1/flock/settings/change_control/device_settings/is_enabled
• /api/v1/flock/settings/change_control/device_settings/is_global
• /api/v1/flock/settings/change_control/device_settings/use_global
• /api/v1/flock/settings/change_control/info
• /api/v1/flock/settings/whitelisting/ip/disable
• /api/v1/flock/settings/whitelisting/ip/enable
• /api/v1/flock/settings/whitelisting/ip/inherit_global/disable
• /api/v1/flock/settings/whitelisting/ip/inherit_global/enable
• /api/v1/flock/settings/whitelisting/ip/is_enabled
• /api/v1/flock/settings/whitelisting/ip/is_global
• /api/v1/flock/settings/whitelisting/ip/is_ip_whitelisted
• /api/v1/flock/settings/whitelisting/ip/sanitized
• /api/v1/flock/settings/whitelisting/ip/save
• /api/v1/flock/settings/whitelisting/ip/string
• /api/v1/flock/settings/whitelisting/ip/use_global
• /api/v1/flock/settings/whitelisting/ip/whitelist_ip_port
• /api/v1/flock/auth_token/add
• /api/v1/flock/auth_token/remove
• /api/v1/flock/auth_token/list
• /api/v1/flock/settings/whitelisting/info
• /api/v1/flock/settings/notifications/info
• /api/v1/flock/settings/webhooks/info
• /api/v1/flock/settings/ignorelist/hostname/disable
• /api/v1/flock/settings/ignorelist/hostname/enable
• /api/v1/flock/settings/ignorelist/hostname/ignorelist_hostname
• /api/v1/flock/settings/ignorelist/hostname/is_enabled
• /api/v1/flock/settings/ignorelist/hostname/is_global
• /api/v1/flock/settings/ignorelist/hostname/is_hostname_ignorelisted
• /api/v1/flock/settings/ignorelist/hostname/sanitized
• /api/v1/flock/settings/ignorelist/hostname/save
• /api/v1/flock/settings/ignorelist/hostname/string
• /api/v1/flock/settings/ignorelist/hostname/use_global
• /api/v1/flock/settings/notifications/email
• /api/v1/flock/settings/notifications/email/add
• /api/v1/flock/settings/notifications/email/disable
• /api/v1/flock/settings/notifications/email/enable
• /api/v1/flock/settings/notifications/email/is_enabled
• /api/v1/flock/settings/notifications/email/is_global
• /api/v1/flock/settings/notifications/email/save
• /api/v1/flock/settings/notifications/email/use_global
• /api/v1/flock/settings/notifications/operational_email
• /api/v1/flock/settings/notifications/operational_email/add
• /api/v1/flock/settings/notifications/operational_email/disable
• /api/v1/flock/settings/notifications/operational_email/enable
• /api/v1/flock/settings/notifications/operational_email/is_enabled
• /api/v1/flock/settings/notifications/operational_email/is_global
• /api/v1/flock/settings/notifications/operational_email/save
• /api/v1/flock/settings/notifications/operational_email/use_global
• /api/v1/flock/settings/notifications/sms
• /api/v1/flock/settings/notifications/sms/add
• /api/v1/flock/settings/notifications/sms/disable
• /api/v1/flock/settings/notifications/sms/enable
• /api/v1/flock/settings/notifications/sms/is_enabled
• /api/v1/flock/settings/notifications/sms/is_global
• /api/v1/flock/settings/notifications/sms/save
• /api/v1/flock/settings/notifications/sms/use_global
• /api/v1/flock/settings/webhooks/disable
• /api/v1/flock/settings/webhooks/enable
• /api/v1/flock/settings/webhooks/generic
• /api/v1/flock/settings/webhooks/generic/list
• /api/v1/flock/settings/webhooks/generic/add
• /api/v1/flock/settings/webhooks/generic/remove
• /api/v1/flock/settings/webhooks/generic/test
• /api/v1/flock/settings/webhooks/is_enabled
• /api/v1/flock/settings/webhooks/is_global
• /api/v1/flock/settings/webhooks/ms_teams
• /api/v1/flock/settings/webhooks/ms_teams/add
• /api/v1/flock/settings/webhooks/ms_teams/remove
• /api/v1/flock/settings/webhooks/ms_teams/test
• /api/v1/flock/settings/webhooks/slack
• /api/v1/flock/settings/webhooks/slack/remove
• /api/v1/flock/settings/webhooks/slack/test
• /api/v1/flock/settings/webhooks/splunk
• /api/v1/flock/settings/webhooks/splunk/add
• /api/v1/flock/settings/webhooks/splunk/remove
• /api/v1/flock/settings/webhooks/splunk/test
• /api/v1/flock/settings/webhooks/use_global
• /api/v1/flock/create
• /api/v1/flock/delete
• /api/v1/flock/move
• /api/v1/flock/rename
• /api/v1/users/flock/assign/managers
• /api/v1/users/flock/assign/watchers
• /api/v1/flock/settings/ignorelist/src_port/disable
• /api/v1/flock/settings/ignorelist/src_port/enable
• /api/v1/flock/settings/ignorelist/src_port/ignorelist_src_port
• /api/v1/flock/settings/ignorelist/src_port/is_enabled
• /api/v1/flock/settings/ignorelist/src_port/is_global
• /api/v1/flock/settings/ignorelist/src_port/is_src_port_ignorelisted
• /api/v1/flock/settings/ignorelist/src_port/sanitized
• /api/v1/flock/settings/ignorelist/src_port/save
• /api/v1/flock/settings/ignorelist/src_port/string
• /api/v1/flock/settings/ignorelist/src_port/use_global
• /api/v1/flock/note
• /api/v1/flock/note/add
• /api/v1/flock/note/delete
• /api/v1/flock/list
• /api/v1/flock/settings
• /api/v1/flock/summary
• /api/v1/flock/users
• /api/v1/flocks/filter
• /api/v1/flocks/list
• /api/v1/flocks/summary
• /api/v1/incidents/acknowledged
• /api/v1/incidents/all
• /api/v1/incidents/history/source
• /api/v1/incidents/search
• /api/v1/incidents/unacknowledged
• /api/v1/incident/acknowledge
• /api/v1/incident/delete
• /api/v1/incident/fetch
• /api/v1/incident/unacknowledge
• /api/v1/incidents/acknowledge
• /api/v1/incidents/delete
• /api/v1/incidents/unacknowledge
• /api/v1/settings/usermanagement/globally_enforce_2fa/disable
• /api/v1/settings/usermanagement/globally_enforce_2fa/enable
• /api/v1/user/add
• /api/v1/user/disable
• /api/v1/user/edit
• /api/v1/user/edit/access_level
• /api/v1/user/enable
• /api/v1/user/2fa/disable
• /api/v1/user/flock/assign
• /api/v1/user/flock/unassign
• /api/v1/user/note/add
• /api/v1/user/note/delete
• /api/v1/user/password/reset
• /api/v1/user/remove
• /api/v1/user/webauthn/disable
• /api/v1/user/get
• /api/v1/user/auth
• /api/v1/users/filter
• /api/v1/users/list