How to use the API

Current version: 1.1. Previous versions: 1.0.

Upgrading from v.1.0

  • Monitor endpoints are renamed to cron, to avoid confusion.

  • Lists support pagination through offset and limit parameters.

  • Lists return a status, total amount of results and a separate results set.

  • Lists for cron and certificate endpoints return events, instead of logs.

  • Events endpoint was added. You can, for example, use this to list events inside your own dashboard. Do not use this endpoint to trigger other events inside your application. For these use cases we are developing an event push service.

General use of the API

  • All requests must be send over HTTPS.

  • All requests must contain an API key (except the cron job pulse service).

  • All of our server responses are in JSON format.

  • The HTTP response code should always be 200. All other response codes are system errors.

  • The status value is ok, if successful, or error if there are errors in your request. The reason for an error can be found inside reason.

To prevent abuse, please limit the maximum number of retries in case of an error. Our server might block your IP address, if we spot unusual high amounts of traffic.

API keys are not safe in client-side code, like Javascript. We've chosen to use API keys to make our features accessible for a wide audience. If you want to use the API in Javascript, please consider a server side languages between your client side code and our API.

Cron job monitor pulse (heart beat) code examples

curl "https://api.cronly.app/1.1/cron/pulse?token={token}"
<?php
file_get_contents("https://api.cronly.app/1.1/cron/pulse?token={token}");
import urllib2
try:
urllib2.urlopen("https://api.cronly.app/1.1/cron/pulse?token={token}")
except Exception:
pass
var https = require('https');
https.get("https://api.cronly.app/1.1/cron/pulse?token={token}");