API Authentication

All API requests require authentication using an API key passed in the X-API-Key header.

API Key Format

X-API-Key: YOUR_API_KEY

Example Request

curl -H "X-API-Key: YOUR_API_KEY" \
  https://api.portsix.io/api/v1/ip/8.8.8.8

Generating API Keys

API keys can be generated from the dashboard. Each key can be assigned specific permissions and rate limits. Keys should be kept secure and never committed to version control.

Error Responses

Invalid or missing API keys will return a 401 Unauthorized response:

{
  "status": "error",
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or has been revoked"
  }
}

Next Steps

Once authenticated, explore the available endpoints in the API Reference.