Overview

The API is a small JSON interface over HTTPS. The CLI uses it, so anything the CLI does you can do yourself.

https://api.rippler.io

Response format

Every response is wrapped, so a client can branch on one field:

{ "success": true, "data": { "monitors": [] } }

{ "success": false, "error": { "message": "Project not found" } }

Trailing slashes

Every path ends in one. Without it you get a 308 redirect, and a POST body does not survive it. Send /v1/monitors/, not /v1/monitors.

Authentication by endpoint

Management endpoints under /v1/ are authenticated with your API token and act on your team.

Ping endpoints under /ping/ take no token. The ping URL contains a secret id, and holding it is the authorisation, so a job does not need your account credentials to report a run.

Rate limits

Both are limited to 120 requests per minute per IP. Over that you get a 429.

A first request

curl -H "Authorization: Bearer $RIPPLER_API_TOKEN" \
  https://api.rippler.io/v1/monitors/