Authentication

The Hyperping API uses token-based authentication. All API requests must include your API key in the Authorization header.

🔑API Key Required

You need a valid API key to make requests to the Hyperping API.

Getting your API key

To obtain your API key, go to the Developers tab in your project settings.

Creating an API key

Click the "Create key" button to generate a new API key. You can configure:

API Key Options

Namestringrequired

A descriptive name to identify this key (e.g., "Production", "CI/CD Pipeline")

Permissionsenumrequired

Access level for this key

Available options:

Read & WriteRead-only

Expirationdateoptional

When the key should expire. Set to "Never" for keys that don't expire.

⚠️Store your key securely

Your API key will only be shown once when created. Store it in a secure place, such as a password manager or secret store. If you lose your key, you'll need to create a new one.

Using your API key

Include your API key in the Authorization header of all requests using the Bearer token format:

Authorization Header

Authorization: Bearer YOUR_API_KEY

Example request

cURL

curl https://api.hyperping.io/v1/monitors \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Permission levels

Permission Reference

Read & Write

Full access to all API endpoints. Can create, read, update, and delete resources. Use this for integrations that need to make changes.

Read-only

Can only read data from GET endpoints. Cannot create, update, or delete resources. Ideal for dashboards, monitoring, and reporting integrations.

Error responses

If authentication fails, you'll receive one of these error responses:

401 UnauthorizedJSON

{
  "error": "Invalid or missing API key"
}

403 ForbiddenJSON

{
  "error": "Insufficient permissions for this action"
}

💡Tip

Use environment variables to store your API key instead of hardcoding it in your application. This keeps your key secure and makes it easy to rotate.