The CheckCentral API provides an endpoint for creating checks programmatically. All of the configuration options are available through the API, detailed below. To create a new check through the API, you will require an API token for your organization with Read/Write access. Organization administrators can create tokens through the API portal on your dashboard.
The endpoint is located at https://api.checkcentral.cc/createCheck/?apiToken=APITOKEN where the APITOKEN placeholder is replaced with your valid token. The request must be made with the Content-Type header set to application/json. The body of the request should contain as many of the properties listed below as required to define the check. Any properties not passed will be set to their default value.
https://api.checkcentral.cc/createCheck/?apiToken=APITOKEN
Content-Type
application/json
For example, to create a new check that:
you would send the following json in the body of the request:
The check data must include a name property, as well as at least one of email_alias and matching_conditions to allow the check to be matched against incoming messages.
name
email_alias
matching_conditions
The complete list of possible properties for check configuration are as follows:
The name for the new check.
The name parameter is required.
The plus alias for the check. This will be used to generate the custom email address for the Check along with your organization account name: account_name+email_alias@mycheckcentral.cc.
At least one of the email_alias or matching_conditions parameters must be specified.
The rules that will be used to match incoming messages. See the definition of a ConditionGroup below.
{}
group_id
The ID of the group to assign this check. IDs may be retrieved from the getGroups API endpoint.
description
A text description for the check.
interval_type
The interval unit CheckCentral will use to calculate the expected arrival time of incoming messages
One of:
day
interval_value
The number of interval units (see above) used when calculating the expected arrival of incoming messages.
1
overdue_minutes
How many minutes after the interval has elapsed CheckCentral will wait before flagging the check as failed.
30
window_start
An optional time of day when messages will begin to be received.
00:00
window_end
An optional time of day when messages will cease to be received.
active_days
Pass an array of days to indicate which days the check should expect to receive messages.
An array containing either "all", or any of:
"all"
[ "all" ]
enabled_notifications
Pass an array of personal notification services to configure the check to send alerts via those services.
An array containing any of:
[]
enabled_integrations
Pass an array of organization notification services to configure the check to send alerts via those services.
notify_returned_to_success
Checks with this flag will send an alert when they are restored to a success state by an incoming message.
true
notify_outside_window
Checks with this flag set to false will only send alerts during the time window and active days configured above.
notify_consecutive_alerts
This parameter controls when CheckCentral will send alerts about repeated failure or warning messages.
always
notify_consecutive_alerts_limit
If notify_consecutive_alerts is set to either after_n or every_nth, this parameter configures how many consecutive failures or consecutive warnings will trigger alerts.
notify_failure_grace_period
The number of minutes this check will wait to send alerts about failures. If the check is returned to successful status before this period elapses, any pending alerts will be cancelled.
0
default_status
The default status for incoming messages that don't match against any of the conditions below.
failure
success_conditions
The rules that determine whether incoming messages will be set to success. See the definition of a ConditionGroup below.
warning_conditions
The rules that determine whether incoming messages will be set to warning. See the definition of a ConditionGroup below.
failure_conditions
The rules that determine whether incoming messages will be set to failure. See the definition of a ConditionGroup below.
required_conditions
This parameter controls whether incoming messages must meet any or all of the conditions defined below to be considered a match.
condense_whitespace
If this flag is set, all of the conditions defined in this group will treat multiple whitespace characters as a single space.
false
conditions
The list of conditions for this ConditionGroup to match messages against. See the definition of a Condition below.
message_field
Which part of the incoming message will be examined for this condition.
subject
matches
What matching rule this condition will use.
contains
value
The value to use with the above matching rule and message component.
If you have websites that you're in charge of maintaining the SSL certificates for, you can monitor them for expiring certificates using this PowerShell script. The script can be run from anywhere, as it connects to the public URL for the website, and it will email the results wherever you like. You can set it up to email yourself, or you can configure it to email the results to CheckCentral so that you can automate the status parsing.
As always, if you run into any trouble configuring your Checks, please feel free to contact us and we'll be glad to help out.
We're pleased to announce several updates to CheckCentral, with improvements to Check schedules and dashboard interaction.
We have streamlined the frequency settings for checks, with options for simple and advanced scheduling. With advanced schedules, you can now specify both a daily time window to expect emails, and choose which days of the week emails will be sent.
As well, check filters on your dashboard can now be bookmarked, as the filter will be remembered when refreshing the page or sharing the URL. Also, filtering the checks on your CheckCentral dashboard will only display checks from uncollapsed groups, solving an issue that resulted in displaying all checks from a group when uncollapsing it with filters applied.
Additionally, the CheckCentral Data API can now return the recent history of a check's activity if requested.
If you have feedback or questions about these updates or any aspect of CheckCentral, please let us know!
Comet Backup is an excellent tool for MSPs who manage file backups for their clients. By using CheckCentral and Comet Backup together, you can have a clear and easy view of your client backups without having to wade through mountains of email notifications. This guide provides details on setting up Checks for Comet Backup notification emails.
We're happy to announce updates to both the Activities and Stats pages! The searching and filtering on these pages has been improved and expanded, with new and more detailed options available.
The Activities page now provides the ability to filter activities by group, date range, and even the source of the activity: email messages, overdue activities, user-set statuses, or updates from the CheckCentral API.
The Stats page has also been updated to allow filtering by the activity source, as well as by only a specific check. As always, any search on the Stats page can be saved as a PDF or CSV format report.
We hope these updates will make it even easier and more convenient to find and report on only the information that is important to you!
We're excited to announce a recent update to the Manage Checks page for CheckCentral. Reordering Groups is now much faster and easier, with all your groups displayed in one place in a sidebar. You can also drag and drop checks directly on the group in the sidebar to move them between groups. In addition, the page and its content have been streamlined to improve the performance and responsiveness for organizations with large numbers of checks.
We hope this update will make it faster and easier to manage your checks. If you have feedback or questions, please let us know!
Today we're happy to announce that we've added another two-factor authentication (2FA) method. In addition to the current SMS 2FA method, you can now choose to use time-based one-time password (TOTP) 2FA instead, allowing you to get your 2FA codes through your favourite authentication app.
The TOTP method will work with any app the supports TOTP, including Google Authenticator, Duo, Authy, and more! With TOTP you also get an upgrade in security for your 2FA codes, since they can't be intercepted like SMS messages.
If you've already got SMS 2FA enabled, you'll get a prompt when logging in that suggests switching to TOTP. You'll have to disable SMS 2FA first, then setup TOTP. All of the 2FA configuration is done on your account page: https://www.checkcentral.cc/Account/
We highly recommend enabling TOTP 2FA on your account for better security, and as always, if you run into any trouble at all, please don't hesitate to contact us.
We're excited to announce a number of updates to CheckCentral!
We've added the ability to collapse groups on your dashboard to make it easier to see only the information you need to see. The groups you collapse will be remembered whenever or wherever you login to CheckCentral!
New options for failure notifications give you more control over when you are alerted about the status of your checks. A check with a configured "failure notification grace period" will wait to send alerts until the specified time has elapsed. If the check returns to success before the alert is sent, it will be canceled.
The repeated failure option provides several options to control failure notifications when a Check receives multiple consecutive failures:
As well, newly created checks will now have an initial starting activity (set to Success). This will allow the check to become marked overdue once the specified interval has elapsed. To leave the check in a neutral state that will not become overdue until a message has been received, you can delete that created activity.
In addition to these notification updates, we have also made several UI improvements and fixes, including the text for overdue check alerts and organization logos on PDF reports. If you have feedback or question about any of these updates, or anything else, please let us know!
We're excited to announce the new "setCheckStatus" endpoint for the CheckCentral API! This is the first writable endpoint for the API. SetCheckStatus allows authenticated requests to update the status of a specific check. As well, the request can include an associated message, and optionally send alert notifications for the check as well.
Only API tokens that are configured with Read/Write access will be able to make requests to this endpoint. Existing API tokens are set as "Read Only", with all the same permissions they currently have. You can modify a token's access level on your organization's API token management page, available under the "Organization" menu for organization administrators.
As well as the API update, we've also included the option for CSV export on your organization's stats page. Any search on the stats page can be saved as a CSV report by clicking the "Save CSV" button.
If you have any feedback, suggestions, or questions about the API or CheckCentral in general, please let us know!
We're happy to announce that we have expanded the options for generating PDF reports! PDFs for individual checks can now be generated with activity history for a custom date range, and to cap the displayed history to a configured limit.
As well, you can now generate PDF reports from the Organization Stats page. To help with creating reports, the stats page also provides the option to only display stats for a specific check group. Please let us know if you have any feedback!
In addition, we have released an update to iOS notifications to improve performance and reliability.