Authentication

Overview

The Pinnacle API authenticates requests using API keys that you can generate and manage in your Pinnacle Dashboard. Every API request must include a valid API key to access Pinnacle’s services.

Using Your API Key

Pinnacle uses the PINNACLE-API-KEY header for authentication. Include your API key in every request:

$
curl -X GET "https://api.pinnacle.sh/status" \
>
  -H "PINNACLE-API-KEY: your_api_key_here"

Authentication Errors

If your API key is missing, invalid, or expired, Pinnacle will return a 401 Unauthorized response:

1
{
2
  "error": "Invalid API key."
3
}