List uptime | Modular DS | API documentation

{
  "data": [
    {
      "attributes": {
        "enabled": true,
        "last_ping": {
          "at": "2026-02-10T11:00:00.000000Z",
          "error": "Server error",
          "response_time_ms": null,
          "status": "down",
          "status_code": 503
        },
        "site": {
          "id": 1,
          "name": "Portfolio site"
        },
        "status": "down",
        "status_since": "2026-02-10T11:00:00.000000Z"
      },
      "id": "1",
      "links": {
        "self": "{{base_url}}/api/public/v1/uptime-services/1"
      },
      "type": "site-uptimes"
    },
    {
      "attributes": {
        "enabled": true,
        "last_ping": {
          "at": "2026-09-21T10:00:00.000000Z",
          "error": null,
          "response_time_ms": 312,
          "status": "up",
          "status_code": 200
        },
        "site": {
          "id": 5,
          "name": "Marketing site"
        },
        "status": "up",
        "status_since": "2026-08-01T06:00:00.000000Z"
      },
      "id": "2",
      "links": {
        "self": "{{base_url}}/api/public/v1/uptime-services/2"
      },
      "type": "site-uptimes"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/uptime?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/uptime?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/uptime?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/uptime",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Portfolio-level uptime listing: one row per monitored site with its current status and last ping, answering “is anything down right now” in a single call. Rolling availability windows for one site live in Show site uptime (/sites/{site}/uptime).

JSON:API collection of type site-uptimes, id = the site’s uptime service id. Each entry carries site (id, name), enabled (is the monitor on), status (up / down / unknown), status_since and last_ping (at, status, status_code, response_time_ms, error), plus the usual top-level links, meta and jsonapi. last_ping is null when the monitor has not pinged in the last 30 days.

Example entry:

{"type":"site-uptimes","id":"1","attributes":{"site":{"id":1,"name":"Portfolio site"},"enabled":true,"status":"down","status_since":"2026-02-10T11:00:00.000000Z","last_ping":{"at":"2026-02-10T11:00:00.000000Z","status":"down","status_code":503,"response_time_ms":null,"error":"Server error"}}}

Default sort is -status, so outages come first. An unknown filter value or an out-of-range page[size] answers 422; a member without the uptime read permission answers 404. A read-only token is enough. The MCP twin of this endpoint is the uptime-index tool.

Portfolio-level uptime listing: one row per monitored site with its current status and last ping, answering "is anything down right now" in a single call. Rolling availability windows for one site live in `Show site uptime` (`/sites/{site}/uptime`). JSON:API collection of type `site-uptimes`, id = the site's uptime service id. Each entry carries `site` (`id`, `name`), `enabled` (is the monitor on), `status` (`up` / `down` / `unknown`), `status_since` and `last_ping` (`at`, `status`, `status_code`, `response_time_ms`, `error`), plus the usual top-level `links`, `meta` and `jsonapi`. `last_ping` is null when the monitor has not pinged in the last 30 days. Example entry: ```json {"type":"site-uptimes","id":"1","attributes":{"site":{"id":1,"name":"Portfolio site"},"enabled":true,"status":"down","status_since":"2026-02-10T11:00:00.000000Z","last_ping":{"at":"2026-02-10T11:00:00.000000Z","status":"down","status_code":503,"response_time_ms":null,"error":"Server error"}}} ``` Default sort is `-status`, so outages come first. An unknown filter value or an out-of-range `page[size]` answers 422; a member without the uptime read permission answers 404. A read-only token is enough. The MCP twin of this endpoint is the `uptime-index` tool.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[site][]stringOptional

Limit to one or several sites (integer ids, repeatable)

filter[status][]stringOptional

Current site status: up | down | unknown (repeatable)

filter[service_status][]stringOptional

Monitor on/off: enabled | disabled (repeatable)

filter[s]stringOptional

Free-text search over the site name, slug or url (max 255 chars)

sortstringOptional

status, site_name; prefix with - to invert. Default: -status (outages first)

page[number]stringOptional

page[size]stringOptional

Max 50

Response

200 - Uptime portfolio, one website down

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Example entry:

{"type":"site-uptimes","id":"1","attributes":{"site":{"id":1,"name":"Portfolio site"},"enabled":true,"status":"down","status_since":"2026-02-10T11:00:00.000000Z","last_ping":{"at":"2026-02-10T11:00:00.000000Z","status":"down","status_code":503,"response_time_ms":null,"error":"Server error"}}}