Upflag
Get Started

Documentation

Everything you need to set up error monitoring, uptime checks, and status pages for your app.

Quick Start

Get monitoring running in under a minute. Create an account, grab your API key, and run a single command.

1

Sign up for a free account. No credit card required.

2

Copy your API key from the Errors page in your dashboard. Keys start with uf_.

3

Run the setup command in your project directory:

Terminal

$ npx upflag init

✔ Detected: Next.js project "my-app"

✔ API key validated

✔ Monitor created for https://my-app.com

✔ Error alert snippet added to app/layout.tsx

The CLI auto-detects your framework (Next.js, Vite, Astro, or plain HTML), injects the error tracking snippet, and creates an uptime monitor for your app URL. You're done.

Error Monitoring

Upflag tracks JavaScript errors in your production app and translates them into plain English. Instead of a raw stack trace, you get a clear explanation of what broke and where.

How it works

  • A lightweight script tag is added to your app (automatically by npx upflag init or manually).
  • The snippet captures unhandled errors and unhandled promise rejections in your users' browsers.
  • Each error is grouped by message and URL so you see unique issues, not thousands of duplicate events.
  • Upflag generates a plain-English summary for each error group, explaining what went wrong in words anyone can understand.

What you see in the dashboard

  • A list of error groups with the human-readable summary, event count, and the page URL where it occurred.
  • Status per group: Open, Resolved, or Ignored.
  • Drill into any error to see the raw error message, the stack trace, browser info, and a timeline of occurrences.

Manual setup

If you prefer to add the snippet by hand, paste this inside your <head> tag:

<script src="https://upflag.io/api/v1/snippet?key=uf_YOUR_KEY" defer></script>

Replace uf_YOUR_KEY with the API key from your dashboard.

Uptime Monitors

Uptime monitors ping your HTTP endpoints on a regular interval and track whether they respond with a success status code (2xx or 3xx).

Creating a monitor

  • Go to Monitors in your dashboard and click Add Monitor.
  • Enter a name (e.g. "API", "Website", "Payments").
  • Enter the URL to check.
  • Choose a check interval: 30 seconds (Pro), 1 minute (Starter), or 5 minutes (Free).

How downtime is detected

If two consecutive checks fail, the monitor is marked as down and an incident is created automatically. When the endpoint recovers, the incident is resolved and your status page updates in real time.

Monitor limits by plan

  • Free: 3 monitors, 5-minute interval
  • Starter: 15 monitors, 1-minute interval
  • Pro: 50 monitors, 30-second interval

Status Pages

Give your users a public page that shows the real-time health of your services.

Setting up a status page

  • Navigate to Status Pages in your dashboard and click Create Status Page.
  • Give it a name and a slug. The slug becomes your public URL:

https://upflag.io/status/your-slug

  • Assign the monitors you want displayed. Each monitor shows its current status (up, down, or degraded) and recent uptime history.
  • Visitors can subscribe with their email to receive incident notifications.

Custom domains (Starter & Pro)

On a paid plan, serve your status page from your own domain (e.g. status.yourapp.com). Go to Settings, enter your domain, and create a CNAME record pointing to:

upflag.io

Once DNS propagates and verification passes, your status page will be accessible at your custom domain with automatic SSL.

Incidents

Incidents are created automatically when a monitor goes down, and resolved automatically when it recovers. You can also create incidents manually for planned maintenance. Each incident has a status you can update as you work through it:

  • Investigating — you're looking into the issue
  • Identified — you've found the root cause
  • Monitoring — a fix is deployed and you're watching
  • Resolved — the issue is fixed

Status updates are posted to your public status page and emailed to subscribers.

Alerts & Notifications

Upflag sends two types of alerts: error alerts for your team and incident notifications for your users.

Plain-English error alerts

When your app throws an error, Upflag emails you a summary that explains what went wrong in simple terms. No stack trace decoding required. The alert includes:

  • A plain-English description of the error
  • The page URL where it occurred
  • How many users were affected
  • A link to the full error details in your dashboard
Alert from Upflag — 2 minutes ago

Your /checkout page is broken.

The payment form can't load — a required piece of data is missing from the customer record. 12 visitors hit this in the last hour.

View details in dashboard →

Incident notifications for subscribers

Users who subscribe to your status page receive email notifications when incidents are created, updated, or resolved. This keeps your users informed without you needing to send manual updates.

Alert limits by plan

  • Free: 100 error alerts per day
  • Starter: 1,000 error alerts per day
  • Pro: 10,000 error alerts per day

CLI & MCP Integration

Upflag is built for developers who use AI coding tools. The CLI and MCP server let you set up monitoring and check on your app without leaving your editor.

CLI: npx upflag init

The CLI handles everything in one command:

  • Detects your framework (Next.js, Vite, Astro, HTML)
  • Validates your API key
  • Creates an uptime monitor for your app URL
  • Injects the error tracking snippet into your entry file

No config files, no dependencies to install. Just run the command and you're monitored.

MCP Server for Claude Code

The Upflag MCP server exposes three tools that AI coding assistants like Claude Code can use directly:

add_monitoring

Adds monitoring and error tracking to a project. Creates an uptime monitor and injects the error tracking snippet automatically.

check_status

Returns the current state of your monitors (how many are up or down) and a count of open error groups and recent events.

list_errors

Lists recent errors with their plain-English summaries, event counts, and affected URLs. Filter by status (open, resolved, ignored).

Setting up the MCP server

Add the Upflag MCP server to your Claude Code configuration with your API key:

{
  "mcpServers": {
    "upflag": {
      "command": "npx",
      "args": ["-y", "@upflag/mcp-server"],
      "env": {
        "UPFLAG_API_KEY": "uf_YOUR_KEY"
      }
    }
  }
}

Once configured, you can ask Claude Code things like "check my app status" or "show me recent errors" and it will call the Upflag tools directly.

Plans

Upflag offers three plans. Start free and upgrade as you grow. No hidden fees, cancel anytime.

Free

$0/month

For side projects and small apps.

  • 3 monitors
  • 5-minute check interval
  • 1 status page
  • 100 error alerts/day
  • 7-day data retention
  • Email alerts

Starter

$15/month

For growing teams that need faster checks.

  • 15 monitors
  • 1-minute check interval
  • 5 status pages
  • 1,000 error alerts/day
  • 90-day data retention
  • Custom domains

Pro

$49/month

For teams that need maximum reliability.

  • 50 monitors
  • 30-second check interval
  • 20 status pages
  • 10,000 error alerts/day
  • 1-year data retention
  • Custom domains
  • Priority support

See full feature comparison on the pricing page, or get started for free.

Ready to get started?

One command. Real-time error alerts and uptime monitoring for your app.

Start free — no credit cardnpx upflag init

Questions? support@upflag.io