Documentation Navigation

Quick Start Guide

Get your first endpoint monitored in under 5 minutes.

Already have an account? Skip to Step 3 to add your first endpoint.

Step 1: Create Your Account

Go to pulseapi.io/auth/register and sign up with your email address.

You'll receive a verification email from noreply@pulseapi.io. Click the link to confirm your address.

Note: Check your spam folder if you don't see the verification email within a minute.

Step 2: Explore Your Dashboard

After email verification, you'll land on your PulseAPI dashboard. We've already set up a few things for you:

  • Default notification channel — your signup email is already configured as a notification channel. Any alerts will go here automatically.
  • Default detection rules — we've pre-configured rules for common problems: HTTP errors (4xx/5xx), slow response times, and connection failures.

You don't need to configure anything to get started. Just add an endpoint.

Step 3: Add Your First Endpoint

Click Add Endpoint in your dashboard and fill in:

  • Name: Something descriptive, like Payment API Health Check
  • URL: The full URL to monitor, e.g. https://api.example.com/health
  • Method: GET (for most health check endpoints)
  • Check Interval: Every 1 minute (or 5 minutes on the Free plan)

Click Save. Monitoring starts immediately — your first check runs within the next minute.

Step 4: You're Done

That's it. PulseAPI will now:

  • Check your endpoint on the configured schedule
  • Record response times and status codes
  • Alert you by email if it detects an error or anomalous behavior

You'll see your endpoint appear in the dashboard with a status indicator. Green means healthy. Within a few checks, you'll start seeing response time data in the chart.

Next Steps

Next: Managing Endpoints → Create Free Account