# OnlineOrNot

> OnlineOrNot is a hosted monitoring service for websites, APIs, browser flows, and scheduled jobs, with alerts and customer-facing status pages.

## What OnlineOrNot Does

OnlineOrNot runs uptime and browser checks, watches for missed heartbeat pings, sends incident and recovery alerts, and publishes service health through status pages. Monitors and related resources can be managed through the web application, CLI, or HTTP API.

## Who It Is For

- Software teams operating websites and APIs
- Developers, founders, and agencies responsible for production services
- Teams that need to monitor scheduled jobs or communicate incidents to customers

## Start Here

1. [Create an account](https://onlineornot.com/get-started)
2. [Follow the getting started tutorial](https://onlineornot.com/docs/tutorials/getting-started)
3. [Create your first uptime monitor](https://onlineornot.com/docs/how-to/uptime-monitoring/create-uptime-check)
4. [Install the CLI](https://onlineornot.com/docs/how-to/cli/install), then [sign in with `onlineornot login`](https://onlineornot.com/docs/how-to/cli/login)
5. [Use the API documentation](https://developers.onlineornot.com/) for programmatic management

## Products And Capabilities

- Monitoring: [Uptime monitoring](https://onlineornot.com/uptime-monitoring), [browser checks](https://onlineornot.com/docs/how-to/browser-checks/scripted-checks), and [heartbeat monitoring](https://onlineornot.com/docs/explanation/heartbeats)
- Incident communication: [Status pages](https://onlineornot.com/docs/how-to/status-pages/create), [alerts](https://onlineornot.com/features/alerts), and [integrations](https://onlineornot.com/features/integrations)
- Programmatic access: [HTTP API](https://developers.onlineornot.com/) and [CLI command reference](https://onlineornot.com/docs/reference/cli-commands)

## Developer And Agent Resources

- [HTTP API documentation](https://developers.onlineornot.com/): API reference for the `https://api.onlineornot.com/v1` base URL
- [OpenAPI description](https://api.onlineornot.com/.well-known/openapi.json)
- [API catalog](https://api.onlineornot.com/.well-known/api-catalog)
- [CLI installation](https://onlineornot.com/docs/how-to/cli/install) and [CLI command reference](https://onlineornot.com/docs/reference/cli-commands)
- [Detailed developer documentation index](https://developers.onlineornot.com/llms.txt)

## Safety And Authentication

- API credentials, tokens, and heartbeat ping URLs are secrets.
- Do not place secrets in monitor definitions or source control. Store them in a secrets manager or protected environment variable.
- Require explicit user approval before remote mutations, including creating, changing, or deleting monitors, status pages, integrations, or tokens.
- [API token and authentication guidance](https://onlineornot.com/docs/explanation/api-tokens)

## External Resources

- [OnlineOrNot service status](https://status.onlineornot.com/)
- [Support](https://onlineornot.com/help)
- [Community](https://onlineornot.com/community)
- [GitHub](https://github.com/onlineornot)