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.

For example, to create a new check that:

• Receives messages at the address "demo+apicheck@mycheckcentral.cc"
• Expects messages every two hours
• Expects messages only on weekdays
• Is set to Failure unless the message subject is "Message Success" or the message body has the text "No Errors Reported"

you would send the following json in the body of the request:

{
  "name": "An API Check",
  "email_alias": "apicheck",
  "interval_type": "hour",
  "interval_value": 2,
  "active_days": [
    "mon",
    "tue",
    "wed",
    "thu",
    "fri"
  ],
  "success_conditions": {
    "required_conditions": "any",
    "conditions": [
      {
        "message_field": "subject",
        "matches": "exactly",
        "value": "Message Success"
      },
      {
        "message_field": "body",
        "matches": "contains",
        "value": "No Errors Reported"
      }
    ]
  }
}

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.

The complete list of possible properties for check configuration are as follows:

Check Structure

• Name the Check. It can be whatever you like, for example

  Website Certificate Expiry Check

  .
• Select an existing Check Group or create a new one by clicking

  

  Add Check Group

  .
• Select an existing Label or create a new one by typing the name in the text field of the dropdown. (optional)
• Add a description (optional).
The Asset ID is used exclusively with certain ticketing systems and is not required for Checks. Asset ID details and ticketing systems are more fully covered by other documents (e.g. Halo Integration (asset ID).)
• Leave the Asset ID blank.

• Leave "Scheduled" selected as we will be running the script regularly.
• Assuming you'll run the script daily, leave the Expected Interval on "1" "Day(s)." If you plan to run the script on another interval, adjust accordingly.
The initial expectation time is set by the first email message that is received and processed by its Check. (For example, if a notification email arrives at noon and its Check is set for every half hour, it will expect another notification email at 12:30.)
• Leave the Set as Overdue setting at "After 30 Minutes." If the script notification email is not received after this amount of time has been exceeded, the Check will be marked as a failure.

• Leave the default selections enabled.
• Copy the unique email address for later use by clicking on the Copy icon

  

  .

• Set the rule to "Subject contains WARN" by leaving the default dropdown selections and typing

  WARN

  (all caps) in the empty text field.

• Select the desired means of Notification. If in doubt of the selections here, leave the defaults.

• From the Save tab, click the "Save Check" button.

• Download the script: CheckWebsiteCertExpiry.zip.
• Extract it somewhere on the computer (e.g. C:\Scripts). There will be three files: CheckWebsiteCertificateExpiry.ps1, createScheduledTask.ps1, and websites.txt
• Edit the websites.txt file to contain the list of websites you want the script to check. Save it. Make sure to put one URL on each line.
• Open a PowerShell console and run the script to make sure it works. For example:

  Code

  Copy

  Select All

  .\CheckWebsiteCertExpiry.ps1 -Websites (Get-Content websites.txt) -EmailFromAddress {Email From Address} -EmailToAddress {Check Email Address}

• Refresh the Check page or Dashboard to see the new Activity for your Check.
Scheduling
You're ready to set up the Windows Scheduled Task so the script will automatically run each day.
• First, edit the parameters at the top of the CreateScheduledTask.ps1 script and save the changes.
• You'll see the new Scheduled Task in the Windows Task Scheduler. Run it and verify that a second Activity shows up in the CheckCentral Check.

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.

Advanced Check Frequency Settings

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.

Filtered Collapsible Dashboard Groups

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!

Create and Identify
Checks can be added from various locations in the CheckCentral interface, from the Dashboard, Checks page, Activity page, and the Check Group details page.
1. Wherever you are, begin by clicking

   "

   

   Add Check

   ."
   
2. Select "Start Fresh," and click "Start."
   
3. Name the Check. It can be whatever you like, but we would recommend something like:

   {comet username}: {protected item name}

   . For this example, the name will be

   User01: Documents

   .
4. Select an existing Check Group or create a new one by clicking "

   

   Add Check Group

   ."
5. Select an existing Label or create a new one by typing the name in the text field of the dropdown (optional).
6. Add a description (optional).
The Asset ID is used exclusively with certain ticketing systems and is not required for Checks. Asset ID details and ticketing systems are more fully covered by other documents (e.g. Halo Integration (asset ID).)
7. Leave the Asset ID blank unless you've configured your External Ticketing System and have obtained the appropriate ID from that Ticketing System.
Your Check so far will look something like this:

Navigate to the next step in CheckCentral by clicking the "Next" button or the tab name.
Schedule
For this guide, we'll assume this Comet Protected Item has a schedule assigned to it. In order for CheckCentral to notify you when the Check is overdue (e.g. if the Protected Item didn't run as scheduled, or got hung up on its last run), you'll need to configure how often you expect the email to come in. Typically you'll set the Expected Interval values to match the schedule on your Protected Item. In our example, the Protected Item is set to run every day at 9am.
8. Leave "Scheduled" selected.
9. Since the Comet job will run daily, leave the Expected Interval on "1" "Day(s)." If your Comet job will run on another interval, adjust accordingly.
The initial expectation time is set by the first email message that is received and processed by its Check. (For example, if a notification email arrives at noon and its Check is set for every half hour, it will expect another notification email at 12:30.)
10. Leave the Set as Overdue setting at "After 30 Minutes." If the Comet notification email is not received after this amount of time has been exceeded, the Check will be marked as a failure.
Leave Custom Schedule de-selected.

Matching
The Matching step is what matches a notification email to its specific Check. It's also where you'll set the notification's CheckCentral destination email. For CheckCentral to parse notification emails, they must be sent to a "mycheckcentral.cc" address. By default, the email address is [your organization name]@mycheckcentral.cc.
A more unique email address is created using the name given to the Check (with white spaces removed).
11. Copy the unique email address for later use by clicking on the Copy icon

    

    .
While the email address is important for matching, the same address can be used for multiple Comet backup jobs. Those jobs can include multiple Protected Items and multiple containing Vaults, requiring additional Check details to differentiate between various backups jobs. It's best practice to use matching elements that are consistent with and exclusive to the notification emails for each source. In this example, we'll use the Protected Item name and its Vault name to ensure a one-to-one match.
12. Click "

    

    Add Matching Rule

    " to add a set of matching conditions.
13. Select "Subject" and "Contains" from the dropdown selectors, then type your

    {protected item name}

    in the text field. Our example uses

    User01: Documents

    .
14. Click "

    

    Add Matching Rule

    " to add a second set of matching conditions.
15. Select "Body Text" and "Contains" from the dropdown selectors, then type the

    {storage vault name}

    in the text field. Our example uses

    Offsite Comet Server

    .
16. Leave Condense Whitespace and Combine Attachments enabled and the matching modifier set to "All."

The email address will appear different based on your organization name and the name you specified for your check.
Status
The previous Matching step identifies the incoming email to the Check. The Status step looks for indicators of what type of notification you're receiving (e.g. The job was successfully run, it failed, or there were some issues.) The configuration options you choose can vary considerably, but the approach is the same. The Default Status is what is set when the other Rules in this step don't match. Criteria for the remaining statuses then need to be defined, requiring their own unique one-to-one matches.
17. Leave the Default Status on "Failure."
The "Success Criteria" section is where you'll set the criteria that will mark an activity as successful.
18. Click

    

    Add Success Rule

    .
A successful run of a Comet Protected Item will have the word
Success
in the email Subject.
19. Set the rule to "Subject contains Success" by leaving the default dropdown selections and typing

    Success

    (first letter capitalized) in the empty text field.
The "Warning Criteria" section is where you'll set the criteria that will mark an activity with a warning.
20. Click

    

    Add Warning Rule

    .
A warning result of the Comet job notification will have the word
Warning
in the email Subject.
21. Set the rule to "Subject contains Warning" by leaving the default dropdown selections and typing

    Warning

    (first letter capitalized) in the empty text field.
Leave the Condense Whitespace and Combine Attachments checkboxes enabled.

Notifications

Notifications are simply how you want to be informed of Check Failures, Warnings, and some other Status changes.
Email, push, chat and other software can be integrated as well as ticketing systems, allowing for automatic ticket creation and management.
Further configuration is required for each to function and is done via the Notifications tab in the main menu. They can be configured before or after Check creation.
For more understanding of Notification setup, see the CheckCentral Beginner's Guide (Notifications).
22. Select the desired means of Notification. If in doubt of the selections here, leave the defaults.
Save
23. From the Save tab, click the "Save Check" button.
Configure Comet
24. Now that our Check is created, we'll need to configure Comet to send emails to CheckCentral for this user (User01). In the Comet admin interface, go to Accounts > Users > User01, and add the CheckCentral email address you copied earlier. Make sure to click the "Save Changes" button.

Testing
25. Manually run your Comet Protected Item.

26. After the job is done running, refresh your Dashboard. The Check will have a new Status indicator for the recent activity.

Clicking that recent indicator will display the email contents in a modal dialog.

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.

Updated Activities page filtering

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.

Updated Stats page filtering

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!