The Cronitor API exposes all functionality available on the Cronitor dashboard, as well as powerful API-only features.
This document provides an overview of how to interact with Cronitor's API. The complete list of API resources, with links to their documentation, can be found here.
The Cronitor API uses API keys to authenticate requests. Your API keys can be found in the settings page.
Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.
In this guide:
The Cronitor API uses API keys to authenticate requests. Your API keys can be found in the settings page.
Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.
curl https://cronitor.io/api/monitors -u API_KEY:
# The colon prevents curl from asking for a password.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Nota Bene: The Telemetry Events API uses a different authentication mechanism, and is hosted on a separate domain from the rest of the Cronitor API.
When backwards-incompatible changes are made to the Cronitor API, a new, dated version is released. The current version is 2020-10-01.
All requests use your account API settings, unless you override the API version. The changelog lists every available version.
To set the API version on a specific request, send a Cronitor-Version header.
curl https://cronitor.io/api/monitors \
-u API_KEY: \
-H "Cronitor-Version: 2020-10-01"
You can visit any API resource in a browser to view the JSON representation of that resource, and test making API requests using a simple GUI. Try it out — https://cronitor.io/api/monitors
2020-10-01
Previous versions of this API used versioned resources (e.g. /v3/) when making breaking changes. The documentation for those versions can be found here: