Adding tests through the StatusCake API with Postman

Recently we’ve had a lot of requests for examples of how add new tests through the StatusCake API using the popular Postman tool. In this article we’ll take you through some of the steps required to get you going with this method, below you’ll find an example for each test type we offer, taking you through the process of adding a test.

Authentication

First off we need to cover the authentication method that will be required to make the API calls through Postman, you will need to obtain your API key and username from the “User Details” section of the StatusCake App, these should then be input into the “Headers” Section of Postman as shown below:

Uptime Testing

Now that all of our calls will carry with them the required authentication details, we can look at how to proceed in setting up the tests.

Taking the fields from our API documentation you should enter the settings that you’d like applied to the Uptime test that you are adding, every time an uptime test is created you must at least include as a minimum: TestType, Checkrate, WebsiteName, and WebsiteURL. The call should be submitted as PUT.

Page Speed Testing

Page speed testing works similarly, and you can grab the fields that can be used from our API docs here.  The required fields for this one are: name, website_url, location_iso, and checkrate. The POST method is required for this one.

SSL Testing

For SSL testing the PUT method should be utilized, and the required fields are: domain, checkrate, contact_groups, alert_at, alert_expiry, alert_reminder, alert_broken and alert mixed.