Back to features
API
If you can click it, you should be able to script it.
Use the OnlineOrNot API to create checks, inspect results, manage status pages, configure webhooks, and build monitoring into your own provisioning and incident workflows.
- Feature
- OpenAPI-backed HTTP API
- Feature
- Create and manage checks programmatically
- Feature
- Inspect results and audit logs
- Feature
- Automate status page and webhook workflows
Example
curl https://onlineornot.com/v1/checks \
-H "Authorization: Bearer $ONLINEORNOT_API_TOKEN"- Build monitoring into your product.
- Create checks during provisioning, sync status into internal dashboards, or wire OnlineOrNot into your deployment workflow so new services are monitored from day one.
- Checks
- Heartbeats
- Status pages
- Plain HTTP, no ceremony.
- The API is designed to be used directly from scripts, servers, and generated clients.
- REST endpoints
- API tokens
- OpenAPI documentation
- Automate incident plumbing.
- Use the API for workflows that should not depend on a human clicking through the dashboard, such as creating webhooks or pulling check state into an internal tool.
- Webhook management
- Check results
- Audit logs
- Keep the dashboard for humans.
- The dashboard is still there for setup, investigation, and team workflows. The API gives you the same monitoring system when code should be in charge.
- Dashboard workflows
- Scripted workflows
- Generated clients
Frequently asked questions
The short version. The docs have the details when you need them.
- Where are the API docs?
- The API reference lives at developers.onlineornot.com.
- Can I use API tokens?
- Yes. You can create and manage API tokens from the OnlineOrNot app.
- Is there an API reference?
- Yes. The API reference is generated from the OpenAPI spec and lives at developers.onlineornot.com.
- What should I automate first?
- Good starting points are creating checks during service provisioning, listing check status in an internal dashboard, and managing webhooks for incident workflows.
Start with the API.
Use the dashboard for one-off work and the API for the monitoring workflows your team wants to repeat safely.