Uptinio Documentation

Appearance

API Overview ​

Welcome to the Uptinio API documentation. This guide will help you integrate with Uptinio's API.

Authentication ​

All API requests require authentication using an API key. Learn more about authentication.

Base URL ​

https://api.uptinio.com/v1

Available Endpoints ​

Monitoring ​

  • 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

Alerts ​

  • GET /alerts - List all alerts
  • POST /alerts - Create a new alert
  • GET /alerts/:id - Get alert details

Metrics ​

  • GET /metrics - List available metrics
  • GET /metrics/:id - Get metric details
  • POST /metrics/:id/data - Submit metric data

Rate Limits ​

  • 100 requests per minute for standard plans
  • 1000 requests per minute for enterprise plans

Response Format ​

All responses are in JSON format:

json
{
  "data": {
    // Response data
  },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}

Error Handling ​

Errors are returned with appropriate HTTP status codes and a JSON response:

json
{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request parameters"
  }
}

Next Steps ​