Get started with Upstreamr
Eight short guides, in the order a new organization needs them: from your first status page to your providers, probes, alerts, subscribers and the API.
Looking for an endpoint? The API reference ↗ lists every one, with its parameters and answers.
Guides
- Create your status page
From a new account to a public status page: your organization, the page, its components, monitors and your own domain.
- Follow your providers
Add the provider locations you rent in, review the notices that match them, and tell your customers in your own words.
- Probe agents
Run ping, DNS, TLS and private-network checks from your own servers with the probe agent, by hand or over the API.
- Alerts to incidents
Turn a monitor going down, or an alert from Prometheus Alertmanager or Grafana, into a draft incident you review, edit and publish.
- Subscribers and channels
How customers subscribe by email, Discord, Slack, feed or calendar, importing subscribers from another tool, and signed webhooks.
- Game servers
Monitor game servers by their own query protocol: online state, players, map and version, on your status page.
- Private pages
Show a status page only to your customers: by password or by the networks they connect from, with single sign-on on Enterprise.
- The API
Read your pages with the public API and manage them with an API key: authentication, paths, limits and the reference.