API

What it checks

An HTTP request to an endpoint, judged on its status code.

Be aware

Today this is identical to HTTP. Same request, same rules, same fields. There are no JSON assertions: you cannot yet say "the response must contain "status": "ok"" or check a field's value.

We are telling you plainly rather than letting you discover it. The type exists so that API monitors are labelled as such in your list, and so assertions have somewhere to land when they are built.

What to use instead, meanwhile

If your endpoint returns JSON and you want to check its content, Keyword will do it: a substring search over the response body finds "status":"ok" perfectly well. It is cruder than a real assertion — whitespace and key order matter, because it is plain text matching — but it works today.

What to enter

Everything HTTP takes: URL, method, expected status, follow redirects.

Note the same limitation: no custom request headers and no request body. An API that needs an auth header cannot be checked here yet. Point the monitor at a public health endpoint instead, which is what most people want monitored anyway.

Exactly when it's DOWN

Identical to HTTP.

Alerts

Down, recovered, latency.