Getting Started
Quick Start

Quickstart

This guide will help you set up your first monitor and status page in under 5 minutes.

Prerequisites

Step 1: Create Your Organization

After signing up, you'll be prompted to create an organization:

  1. Choose an organization name (e.g., "Acme Corp")
  2. Pick a slug for your status page URL (e.g., acme → acme.statly.live)
  3. Select a plan (Free tier includes 5 monitors)

Step 2: Add Your First Monitor

Navigate to Dashboard → Monitors → Add Monitor:

Name: Production API
URL: https://api.yourcompany.com/health
Method: GET
Expected Status: 200
Check Frequency: 1 minute

Monitors are checked from multiple AWS regions. A service is considered "down" when checks fail from more than one region.

Step 3: Configure Your Status Page

Go to Settings → Status Page to customize:

  • Template: Choose Minimal, Corporate, or Technical
  • Logo: Upload your company logo
  • Primary Color: Match your brand
  • Components: Group monitors into logical sections

Your status page is now live at https://your-slug.statly.live!

Step 4: Create an API Key (Optional)

For programmatic access, create an API key:

  1. Go to Settings → API Keys
  2. Click Create API Key
  3. Name it (e.g., "CI/CD Integration")
  4. Copy the key immediately (it won't be shown again)
# Test your API key
curl -X GET "https://statly.live/api/v1/monitors" \
  -H "Authorization: Bearer sk_live_your_key_here"

Step 5: Install an SDK (Optional)

Add error tracking to your application:

npm install @statly/observe
import { init, captureException } from '@statly/observe';
 
init({
  dsn: 'https://[email protected]/your-org',
  environment: 'production',
});

Next Steps