Getting Started

Create your account at ./signup.

After signing in, you'll see the onboarding wizard. Add your first endpoint:

• Enter your API URL (e.g., https://api.example.com/health)
• Choose HTTP method (GET, POST, etc.)
• Set check interval (1–60 minutes)
• Configure timeout (5–60 seconds)

{
  "url": "https://api.example.com/health",
  "method": "GET",
  "checkInterval": 60,
  "timeout": 10
}

Create a public status page to share uptime with your users. Go to Dashboard > Status Page.

• Choose a unique slug for your URL
• Customize with your logo, colors, and company name
• Select which endpoints to display
• Optionally add a custom domain (e.g. status.yourcompany.com)

PulseAPI automatically sends alerts for:

All alerts go to your signup email. Configure webhooks and Telegram in Settings for additional channels.

Once your endpoint is added, PulseAPI starts monitoring immediately. View:

• Real-time status (Operational, Down, Degraded)
• Response time charts (last 7 days)
• Uptime percentage (24h rolling window)
• Check history table (paginated, sortable)

Create an API key for programmatic access to PulseAPI.

1. Go to Dashboard > Settings > API Keys
2. Click Create, name it, and select scopes (e.g. endpoints:read, alerts:read)
3. Copy the key immediately -- it is shown only once

# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints

# Trigger a manual check
curl -X POST -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints/ENDPOINT_ID/check

See for the full endpoint list.API Reference