Getting Started

API Keys

API keys let you manage monitors programmatically from CI/CD pipelines, Terraform, or custom scripts.

API keys in DeadPing are secret tokens that let you create, update, and delete monitors programmatically. Use them in CI/CD pipelines, Terraform configurations, and custom scripts to manage monitors without the dashboard. Each key is scoped to your account and can be revoked at any time.

Creating a Key

  1. Go to Dashboard → Settings
  2. Under API Keys, click Create New Key
  3. Name the key (e.g. "GitHub Actions", "Terraform")
  4. Copy the key immediately. It's only shown once. Keys start with dp_live_

You can create up to 5 keys per account. Revoke any key at any time from Settings.

Authentication

Pass the key in the X-API-Key header on any API request:

bash
curl -H "X-API-Key: dp_live_abc123..." \
  https://deadping.io/api/monitors

API key auth and session auth are interchangeable. Both return the same data scoped to your account.

Security

  • Never commit keys to git. Use environment variables or a secret manager.
  • Rotate regularly. Create a new key, update your pipelines, delete the old one.
  • Use separate keys per environment (CI, staging, prod) so you can revoke individually.
  • Ping tokens are not API keys. Ping URLs are public by design. They can only record a heartbeat, not read or modify anything.