Getting Started

Welcome to the Pinger developer documentation. Pinger provides a powerful, programmatic way to ensure your infrastructure is running smoothly. From standard HTTP uptime checks to complex JSON assertions and dead man's switch heartbeat monitoring, Pinger helps you detect and resolve incidents faster.

What can you monitor?

Pinger natively supports 11 different monitor types to cover any part of your stack:

• Website & API Monitoring: Test HTTP endpoints, assert on status codes, and measure response times.
• Cron & Heartbeat: Use a dead man's switch to ensure background jobs and workers complete on schedule.
• Database & Cloud: Specialized monitors for Supabase, Redis (TCP), and DNS configurations.
• Security: SSL certificate expiration and Domain expiration tracking.

1. Get your API Key

To interact with the Pinger API, you need to create an API key inside your Workspace. Navigate to Settings > API Keys in the Dashboard and clickCreate Key.

Be sure to select the appropriate scopes (e.g., monitors:read, monitors:write) and securely store the generated token. It will only be shown once.

2. Make your first request

Pinger uses standard HTTP Bearer authentication. Send your API key in the Authorization header.

curl https://api.pingr.site/api/v1/monitors \
  -H "Authorization: Bearer pinger_xxxxxxxxxxxxxxxxx"

3. Create a Monitor

You can dynamically create monitors via the API. This is especially useful for integrating Pinger into your CI/CD pipelines or Infrastructure as Code (IaC) workflows.

curl -X POST https://api.pingr.site/api/v1/monitors \
  -H "Authorization: Bearer pinger_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Website",
    "type": "website",
    "target": "https://pingr.site",
    "intervalSeconds": 60,
    "timeoutSeconds": 10
  }'

Next Steps

Now that you've made your first request, explore the rest of the platform:

• Learn about Authentication and security best practices.
• Review the API Reference for detailed endpoint schemas.
• Integrate Webhooks to receive automated incident alerts.
• Set up Heartbeat Monitoring for your background cron jobs.