Skip to main content

API Overview

The Bareuptime API allows you to programmatically manage your monitoring setup, retrieve data, and integrate with your existing tools.

Base URL​

https://api.bareuptime.co/v1

Authentication​

All API requests require authentication using an API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Getting Your API Key​

  1. Log in to your Bareuptime dashboard
  2. Navigate to Settings → API Keys
  3. Click Generate New Key
  4. Copy and securely store your API key

Rate Limiting​

The API is rate limited to:

  • 100 requests per minute for free accounts
  • 1000 requests per minute for premium accounts

When you exceed the rate limit, you'll receive a 429 Too Many Requests response.

Response Format​

All API responses are returned in JSON format:

{
  "success": true,
  "data": { ... },
  "message": "Success"
}

Error Responses​

When an error occurs, the API returns an error response:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid monitor URL"
  }
}

Available Endpoints​

Monitors​

  • GET /monitors - List all monitors
  • POST /monitors - Create a new monitor
  • GET /monitors/{id} - Get monitor details
  • PUT /monitors/{id} - Update a monitor
  • DELETE /monitors/{id} - Delete a monitor

Monitor Data​

  • GET /monitors/{id}/status - Get current status
  • GET /monitors/{id}/stats - Get statistics
  • GET /monitors/{id}/incidents - Get incident history

Status Pages​

  • GET /status-pages - List status pages
  • POST /status-pages - Create status page
  • PUT /status-pages/{id} - Update status page

Notifications​

  • GET /notifications - List notification channels
  • POST /notifications - Create notification channel
  • PUT /notifications/{id} - Update notification channel

SDKs and Libraries​

Official SDKs are available for:

  • JavaScript/Node.js - npm install bareuptime-sdk
  • Python - pip install bareuptime
  • Go - go get github.com/bareuptime/go-sdk

Examples​

Check out our Monitor API Examples for common use cases and code samples.