Overview
The PingPilot API uses Bearer token authentication. You must include your API key in theAuthorization header of every request.
Getting Your API Key
- Log in to your PingPilot dashboard
- Navigate to Account Settings
- Copy your API key from the API section
Authentication Header
Include your API key in theAuthorization header using the Bearer scheme:
Example Request
Authentication Errors
The API returns specific error messages for authentication failures:Missing Authorization Header
Status Code:401 Unauthorized
Invalid Header Format
If the header doesn’t start with “Bearer ”: Status Code:401 Unauthorized
Invalid API Key
If the API key is empty, invalid, or not found: Status Code:401 Unauthorized
Account Configuration Requirements
After authentication succeeds, PingPilot verifies your account configuration:Discord ID Required
Status Code:403 Forbidden
Configure your Discord ID in account settings to receive Discord notifications.
Telegram Username Required
Status Code:403 Forbidden
Configure your Telegram username in account settings to receive Telegram notifications.
Security Best Practices
- Store securely: Use environment variables or secret management services
- Rotate regularly: Generate new API keys periodically
- Use HTTPS: Always make requests over HTTPS
- Monitor usage: Check your dashboard for unexpected API activity