UptimeTea

API Documentation

The UptimeTea API is easy to use and free for all plans.

Getting Started

To begin using the UptimeTea API, you'll need to understand a few key concepts:

Base URL

All API requests should be made to:

https://api.uptimetea.com

Authentication

Most endpoints require authentication using a Bearer token. Include your token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Obtain your token by logging in via the authentication endpoints.

HTTP Status Codes

The API uses standard HTTP status codes to indicate the success or failure of requests:

  • 200 - Successful request
  • 400 - Bad request (validation errors)
  • 401 - Unauthorized (invalid or missing token)
  • 404 - Resource not found
  • 500 - Server error

Error Response Format

When an error occurs, the API returns a JSON object with an error message:

{
  "error": "Validation error message"
}

Rate Limiting

The API implements rate limiting to ensure fair usage. If you exceed the rate limit, you'll receive a 429 status code.