Welcome to the BinaryCanary.com BETA API. Please note that some functions have not yet been released, and are marked "In Progress" below.

In order to use this API, you will need an API key. To obtain an User API Key, please login and edit your User account to allow an API key and click "Save"

Please contact us at support@binarycanary.com with any feedback, or if you encounter any issues while using this API.

Examples →

Account

Name Status Description
createAccount Active Create an account
deleteAccount In Progress Delete an Account
getAccount Active Get an account
getAccountStats In Progress Get account statistics
listAccounts Active List all accounts in the organization
updateAccount Active Update an account

EscalationProfile

Name Status Description
addContactMethodToEscalationProfile In Progress Add Contact Methods to an Escalation Profile
createEscalationProfile In Progress Create an Escalation Profile
deleteEscalationProfile In Progress Delete an Escalation Profile
getEscalationProfile In Progress Get an Escalation Profile
listEscalationProfiles In Progress List Escalation Profiles
removeContactMethodFromEscalationProfile In Progress Remove a Contact Method from an Escalation Profile
updateEscalationProfileSettings In Progress Update an Escalation Profile's settings

Monitor

Name Status Description
acknowledgeFailure Active Acknowledge a Monitor Failure
createMonitor (DNS) In Progress Create a DNS Monitor
createMonitor (DomainName) In Progress Create a Domain Name Monitor
createMonitor (FTP) Active Create an FTP Monitor
createMonitor (HTTP) In Progress Create an HTTP Monitor
createMonitor (HTTPSimple) Active Create an HTTP Simple monitor
createMonitor (IMAP) In Progress Create an IMAP Monitor
createMonitor (PING) Active Create a PING Monitor
createMonitor (POP3) In Progress Create a POP3 Monitor
createMonitor (PortScan) In Progress Create a Port Scan Monitor
createMonitor (SMTP) In Progress Create an SMTP Monitor
createMonitor (SMTPIMAP) In Progress Create a round trip SMTP-IMAP Monitor
createMonitor (SMTPPOP3) In Progress Create a round trip SMTP-POP3 Monitor
createMonitor (SSL) Active Create an SSL Monitor
createMonitor (TELNET) In Progress Create a TELNET Monitor
deleteMonitor Active Delete a monitor
getMonitor Active Get a Monitor
getMonitorPerformanceByMonth In Progress Get a Monitor's performance by month
getMonitorStats Active Get a Monitor's Stats
listMonitors Active List Monitors
updateMonitor (DNS) In Progress Update a DNS Monitor
updateMonitor (DomainName) In Progress Update a Domain Name Monitor
updateMonitor (FTP) Active Update an FTP Monitor
updateMonitor (HTTP) In Progress Update an HTTP Monitor
updateMonitor (HTTPSimple) Active Update an HTTP Simple Monitor
updateMonitor (IMAP) In Progress Update an IMAP Monitor
updateMonitor (PING) Active Update a PING Monitor
updateMonitor (POP3) In Progress Update a POP3 Monitor
updateMonitor (PortScan) In Progress Update a Port Scan Monitor
updateMonitor (SMTP) In Progress Update an SMTP Monitor
updateMonitor (SMTPIMAP) In Progress Update a round trip SMTP-IMAP Monitor
updateMonitor (SMTPPOP3) In Progress Update a round trip SMTP-POP3 Monitor
updateMonitor (SSL) Active Update an SSL Monitor
updateMonitor (TELNET) In Progress Update a TELNET Monitor
updateMonitorStatus Active Update a Monitor's status

NotificationContact

Name Status Description
createNotificationContact Active Create a Notification Contact
createNotificationContactDND In Progress Create a Notification Contact Do Not Disturb time
createNotificationContactMethod Active Create a Notification Contact Method
deleteNotificationContact Active Delete a Notification Contact
deleteNotificationContactMethod Active Delete a Notification Contact Method
getNotificationContact Active Get a Notification Contact
listNotificationContactDNDs In Progress List a Notification Contact's Do Not Disturb times
listNotificationContactMethods Active List a Notification Contact's methods
listNotificationContacts Active List Notification Contacts
testNotificationMethod In Progress Test a notification method
updateNotificationContact Active Update a Notification Contact
updateNotificationContactDND In Progress Update a Notification Contact's Do Not Disturb time
updateNotificationContactMethod Active Update a Notification Contact Method

Organization

Name Status Description
createOrganization In Progress Create an Organization. (Must have an Affiliate ID)
getBillingHistory In Progress Get the billing history
getOrganizationStats In Progress Get the Organization's statistics
listOrganizations In Progress List all the organizations associated with an Affiliate ID
purchaseNotificationCredits In Progress Purchase Notification Credits
updateOrganization In Progress Update an Organization. (Must have an Affiliate ID)
updateOrganizationSettings In Progress Update an Organization's Settings (Must have an Affiliate ID)

Plan

Name Status Description
getPlan In Progress Get a Binary Canary Plan's information
listPlans In Progress List Binary Canary Plans

Report

Name Status Description
getFailureDetailsByID Active Get monitor failure details by ID
getMonitorFailuresByDateRange In Progress Get monitor failures by date range
listFailures Active List monitor Failures
listNotifications Active List contact notifications

Server

Name Status Description
acknowledgeServer In Progress Acknowledge Server Failures
createServer Active Create a Server
createServerLogEntry In Progress Create a Server Log Entry
createServerMaintenanceWindow In Progress Create a Server Maintenance Window
deleteServer Active Delete a Server
deleteServerLogEntry In Progress Delete a Server Log Entry
deleteServerMaintenanceWindow In Progress Delete a Server Maintenance Window
getServer Active Get a Server
getServerLogEntries In Progress Get Server Log Entries
getServerStats In Progress Get Server statistics
listServerMaintenanceWindows In Progress List Server Maintenance Windows
listServers Active List Servers
updateServer Active Update a Server
updateServerLogEntry In Progress Update a Server Log Entry
updateServerMaintenanceWindow In Progress Update a Server Maintenance Window

User

Name Status Description
createUser Active Create an user
deleteUser Active Delete an user
getUser Active Get an user
getUserAPIKey In Progress Get the user's API Key
getUserStats In Progress Get User statistics
listUsers Active List users
updateUser Active Update an user