# Host Status API

> Create monitors, receive alerts and run your status page from your own code. Everything you can do in the app, you can script over HTTPS with JSON. Base URL `https://app.host-status.io/api`; authenticate with `Authorization: Bearer <API key>`.

Errors are JSON `{"code", "message"}`; branch on `code`. Unknown request fields are rejected. The OpenAPI 3.1 spec is the source of truth.

## Guides

- [Quickstart](https://host-status.io/docs/md/guides/quickstart.md): Make your first call and watch a monitor come up, in five minutes.
- [Authentication](https://host-status.io/docs/md/guides/authentication.md): API keys, roles, and what a key can't do.
- [Errors and limits](https://host-status.io/docs/md/guides/errors.md): One error shape, a short list of codes, and the few rate limits.
- [Multi-location checks](https://host-status.io/docs/md/guides/multi-location.md): Check from several places and only get alerted when it's really down.
- [Push monitors for cron jobs](https://host-status.io/docs/md/guides/push-monitors.md): Get alerted when a backup or scheduled job doesn't run.
- [Webhooks](https://host-status.io/docs/md/guides/webhooks.md): Receive alerts in your own service and verify they came from us.
- [Status pages via API](https://host-status.io/docs/md/guides/status-pages.md): Publish a status page and keep it updated during an incident.

## API reference

- [Monitors](https://host-status.io/docs/md/reference/monitors.md): Checks that run on a schedule, and their results.
- [Status pages](https://host-status.io/docs/md/reference/status-pages.md): Public pages, incidents, subscribers and custom domains.
- [Notifications](https://host-status.io/docs/md/reference/notifications.md): Where alerts go: chat, email, push apps or your own webhook.
- [Maintenance](https://host-status.io/docs/md/reference/maintenance.md): Windows when monitors don't alert.
- [Tags](https://host-status.io/docs/md/reference/tags.md): Labels to group monitors.
- [Push](https://host-status.io/docs/md/reference/push.md): Heartbeats from cron jobs and scripts. No key needed.
- [Public status](https://host-status.io/docs/md/reference/public-status.md): Data from published status pages. No key needed.
- [Account](https://host-status.io/docs/md/reference/account.md): Your account, plan and team.
- [Billing](https://host-status.io/docs/md/reference/billing.md): Your subscription and orders, read-only.

## Optional

- [Full API in one file](https://host-status.io/docs/llms-full.txt): every guide and endpoint in Markdown
- [OpenAPI spec](https://host-status.io/docs/openapi.json): machine-readable, with schemas and examples