Uptinio Documentation

Appearance

Authentication ​

This guide explains how to authenticate with the Uptinio API.

API Keys ​

All API requests require authentication using an API key. You can generate API keys in your Uptinio dashboard under Settings > API Keys.

Getting Your API Key ​

  1. Log in to your Uptinio dashboard
  2. Navigate to Settings > API Keys
  3. Click "Generate New API Key"
  4. Copy the key immediately (it won't be shown again)

Using API Keys ​

Include your API key in the Authorization header of all requests:

bash
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.uptinio.com/v1/monitors

Example Request ​

javascript
const response = await fetch('https://api.uptinio.com/v1/monitors', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

Security Best Practices ​

  1. Never share your API key

    • Keep it secure and private
    • Don't commit it to version control
    • Use environment variables

  2. Rotate keys regularly

    • Generate new keys periodically
    • Revoke old keys when no longer needed

  3. Use different keys for different purposes

    • Separate keys for development and production
    • Different keys for different applications

Rate Limiting ​

API keys are subject to rate limiting:

  • Standard plans: 100 requests per minute
  • Enterprise plans: 1000 requests per minute

Error Responses ​

Invalid API Key ​

json
{
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is invalid"
  }
}

Expired API Key ​

json
{
  "error": {
    "code": "expired_api_key",
    "message": "The provided API key has expired"
  }
}

Rate Limit Exceeded ​

json
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests"
  }
}

Next Steps ​