Developer API

The StatusEagle API lets you access your monitors and incidents programmatically. Build dashboards, integrate with third-party tools, or display real-time uptime data inside your own applications.

Introduction

All API endpoints are served over HTTPS. Requests and responses use JSON. Every successful response contains a success: true key and a data key holding the payload.

You can generate your API key from app.statuseagle.com/api-key.

Authentication

Pass your API key as a Bearer token in the Authorization header on every request.

Base URL

All endpoints below are relative to this base URL.

Errors

Errors return a standard HTTP status code and a JSON body with success: false and a message.

List Monitors

Returns a paginated list of all monitors for the authenticated account, including current status, last check time, and response time.

Query Parameters

Example Request

Response

{
  "success": true,
  "data": {
    "monitors": [
      {
        "id": "mon_abc123",
        "name": "My Website",
        "type": "website",
        "url": "https://example.com",
        "status": "up",
        "last_checked_at": "2026-03-04T10:30:00+00:00",
        "last_checked": "2 minutes ago",
        "response_time": 243,
        "duration": "Up for 3 days",
        "notifications_paused": false,
        "created_at": "2026-01-15T08:00:00+00:00"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total": 42,
      "last_page": 5,
      "from": 1,
      "to": 10
    }
  }
}

Response Fields

Monitors Overview

Returns a summary of all monitors grouped by status. Useful for building dashboard widgets or status badges.

Example Request

Response

{
  "success": true,
  "data": {
    "total_monitors": 42,
    "healthy": 38,
    "critical": 2,
    "down": 1,
    "partial": 1,
    "forbidden": 0,
    "coming_soon": 1,
    "maintenance": 0,
    "paused": 1,
    "uptime_percentage": 97.6
  }
}

Response Fields

Ongoing Incidents

Returns all currently open or investigating incidents for the authenticated account. Incidents are sorted newest first. Use this endpoint to display active outages inside your own applications or dashboards.

Query Parameters

Example Request

Response

{
  "success": true,
  "data": [
    {
      "id": "65f1a2b3c4d5e6f7a8b9c0d1",
      "monitor_id": "mon_abc123",
      "monitor_name": "My Website",
      "monitor_type": "website",
      "favicon": "https://example.com/favicon.ico",
      "cause": "Connection refused",
      "status": "open",
      "started_at": "2026-03-04T08:15:00+00:00",
      "duration": "2 hours"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "last_page": 1
  }
}

Response Fields