Documentation

Sign up at app.greenping.live with your email. No credit card required.

Click "New Page" and enter your page name and URL slug. Your page will be available at greenping.live/s/your-slug.

Components are the services you want to display (e.g., API, Website, Database). Add them from the Components tab. Each component has a status:

• Operational — everything is working normally
• Degraded — reduced performance but functional
• Partial Outage — some users are affected
• Major Outage — service is unavailable
• Maintenance — planned downtime

Share your public URL with your customers, or set up a custom domain for a branded experience. The page is edge-cached and globally distributed — it stays online even if your infrastructure doesn't.

• UptimeRobot — sends alert type (up/down) automatically
• Checkly — sends check results with failure status
• Pingdom — sends current state (UP/DOWN)
• Generic — any tool that can send HTTP POST requests

1. Go to your status page → Webhooks tab
2. Click "Add Webhook"
3. Select the source (UptimeRobot, Checkly, etc.) and target component
4. Copy the generated webhook URL
5. Paste it into your monitoring tool's webhook/notification settings

Send a POST request with this JSON body:

POST /api/webhooks/incoming/{webhook_id}
Content-Type: application/json

{
  "status": "major_outage",
  "message": "API server is not responding"
}

When status is major_outage or partial_outage, an incident is auto-created. When operational, active incidents are auto-resolved.

All API endpoints require authentication via Bearer token (available on Pro and Team plans). Include your access token in the Authorization header.

Change a component's status with a single call:

curl -X PATCH \
  https://api.greenping.live/api/pages/{page_id}/components/{id}/status?status=major_outage \
  -H "Authorization: Bearer YOUR_TOKEN"

curl -X POST \
  https://api.greenping.live/api/pages/{page_id}/incidents \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Database connectivity issues",
    "severity": "major",
    "message": "We are investigating connection timeouts.",
    "affected_components": ["component_id"],
    "status": "investigating"
  }'

curl -X POST \
  https://api.greenping.live/api/pages/{page_id}/incidents/{id}/resolve \
  -H "Authorization: Bearer YOUR_TOKEN"

Auto-resolves the incident, posts a "resolved" update, and resets affected components to operational.

Custom domains are available on all plans, including Free. Point your own subdomain to GreenPing for a fully branded status page experience.

1. Go to your status page → Settings
2. Enter your custom domain (e.g., status.yourcompany.com)
3. Add a CNAME record in your DNS provider:

Type:  CNAME
Name:  status
Value: cname.greenping.live
TTL:   3600

4. Wait for DNS propagation (usually 5-30 minutes)
5. SSL is provisioned automatically — no action needed

• A "Subscribe to updates" form appears on your public status page
• Users enter their email and receive a confirmation link (double opt-in)
• Once confirmed, they receive emails for all incident activity
• Every email includes an unsubscribe link

There is no limit on emails sent per month — the cap is on total confirmed subscribers per status page.