# Uptime-Kuma Status Extractor (`datamule/uptime-kuma-status-extractor`) Actor Point at any Uptime-Kuma status page and export its monitors, latest status, ping and 24h uptime from the public status-page API. One actor over thousands of self-hosted uptime monitors. - **URL**: https://apify.com/datamule/uptime-kuma-status-extractor.md - **Developed by:** [Datamule](https://apify.com/datamule) (community) - **Categories:** Developer tools - **Stats:** 3 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.35 / 1,000 monitors This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Uptime-Kuma Status Extractor **Point at any self-hosted [Uptime-Kuma](https://github.com/louislam/uptime-kuma) status page and export its monitors, latest status, ping and 24-hour uptime as clean, structured rows.** Uptime-Kuma is *the* dominant self-hosted uptime monitor. Every public Uptime-Kuma status page — regardless of version or theme — exposes the same **unauthenticated public JSON API**: - `GET /api/status-page/{slug}` — the page config + monitor tree (`publicGroupList`). - `GET /api/status-page/heartbeat/{slug}` — per-monitor heartbeat history + 24h uptime. This actor speaks that one standard, so **a single actor works against every Uptime-Kuma instance in existence** — no per-host scraper. Give it a status page URL; get back a flat, fully-typed dataset row for every monitor — its group, type, URL, latest status, last ping, 24-hour uptime and page config — ready for a spreadsheet, a database, an uptime/SLA report or an observability pipeline. ### Built for agents - A personal operations agent can check whether home-lab or business services are up before starting a dependent workflow. - An incident agent can turn public status pages into structured monitor state, latency and 24-hour uptime for triage or alerts. - A research agent can compare public Uptime-Kuma fleets without scraping dashboards or holding credentials. The ready-to-run example targets the official Uptime-Kuma demo and returns five live monitors. The form caps the first run at 20 rows, so it is safe to call from an autonomous tool loop. > **Uptime-Kuma only.** ### What it does - **Any Uptime-Kuma page, one input.** Pass the domain base (`https://status.kuma.pet`). The status-page **slug** is resolved automatically via `GET /api/entry-page`, or read from a `…/status/` UI URL, or set explicitly with `slug`. - **Multiple sources per run.** Give a list of status pages; each is harvested independently. - **Three modes.** - **All** (default) — every monitor from the config tree, with latest status / ping / 24h uptime joined from the heartbeat API where available. - **Heartbeat** — only monitors that actually have a heartbeat series (status/ping/uptime populated). - **Monitors** — the monitor tree only; no heartbeat request is made (fastest, config-only). - **Reads by key presence.** Uptime-Kuma instances differ only in which optional fields they populate. A `port` / `dns` / `ping` monitor with no `url`, a page with no open incident, a version that stores incidents under `incident` (singular) vs `incidents` (plural) — every one yields `null` for that column, never an error. - **Harvests the open pages.** A private or unpublished page `404`s its slug — that source is skipped with a logged note and the run continues, never crashing. ### Input | Field | Required | Description | |---|---|---| | `sources` | ✅ | A list of Uptime-Kuma status-page base URLs (e.g. `["https://status.kuma.pet"]`). A `…/status/` UI URL also works — the slug is read from the path. | | `slug` | | The status-page slug to use for **every** source. Leave empty to resolve per source via `/api/entry-page`. Set it when a host serves multiple pages. | | `mode` | | `all` (default), `heartbeat`, or `monitors`. See modes above. | | `maxRecords` | | Global cap on emitted monitor rows across all sources (each row = one billable event). | #### Example inputs ```json { "sources": ["https://status.kuma.pet"] } ```` ```json { "sources": ["https://status.kuma.pet"], "slug": "uptime-kuma", "mode": "all" } ``` ```json { "sources": ["https://status.nixnet.services"], "mode": "monitors" } ``` ```json { "sources": ["https://status.kuma.pet", "https://status.nixnet.services"], "mode": "heartbeat", "maxRecords": 500 } ``` ### Output One row per monitor: | Column | Description | |---|---| | `source` | The status page origin the monitor came from. | | `slug` | The resolved status-page slug. | | `groupId` / `groupName` | The parent group the monitor belongs to (e.g. `Web services`). | | `monitorId` | Uptime-Kuma's numeric id for the monitor. | | `name` | The monitor's display name. | | `type` | Monitor type (`http`, `keyword`, `port`, `dns`, `ping`, …). | | `url` | The monitored URL, for monitors that expose one (`null` for `port`/`dns`/… checks). | | `sendUrl` | Whether the page shows the monitor's URL publicly (`1`/`0`). | | `pageTitle` / `theme` / `published` | Page-level config, promoted onto every row. | | `openIncidentTitle` | Title of the first open incident on the page, else `null`. | | `lastStatus` | Latest heartbeat status: `1` = up, `0` = down, `2` = pending, `3` = maintenance. `null` in `monitors` mode. | | `lastPing` | Latest heartbeat response time in **milliseconds** (`null` when the check records none). | | `lastHeartbeatTime` | Timestamp of the latest heartbeat. | | `uptime24h` | 24-hour uptime ratio (`1` = 100%, `0.9874` = 98.74%). | | `heartbeatCount` | How many heartbeats the page returned for the monitor. | | `_monitorCount` | How many monitors the source page publishes. | | `_raw` | The complete original monitor object — nothing is ever dropped. | Every field is **nullable** and read by key presence — an instance that omits `url` / an incident / a heartbeat simply yields `null` for that column, never an error. ### Notes & scope - **Public status data only.** This reads a status page's public JSON — the same data the dashboard renders in a browser. No login is used or required. - **Honest failure.** A page with no monitors, or every source private, returns **0 records** and a clean success. A URL that isn't an Uptime-Kuma status page (an HTML page, a body with no `publicGroupList`) fails fast with a clear message. - **Find instances.** Any public Uptime-Kuma status page works; the demo at `https://status.kuma.pet` is a good place to try it. ### Pricing Pay-per-event: **$0.0005 per monitor** returned. The current five-monitor demo is **$0.0025** at list price; the 20-row first-run cap is at most **$0.01**. A capped run charges only for what it emits. # Actor input Schema ## `sources` (type: `array`): One or more Uptime-Kuma status-page base URLs (e.g. https://status.kuma.pet). Every Uptime-Kuma instance exposes the same public JSON API (GET /api/status-page/{slug} + /api/status-page/heartbeat/{slug}), so one actor works against any of them. Give the domain base; the slug is resolved automatically via /api/entry-page, or set the 'slug' input to override. A status-page UI URL like https://host/status/mypage also works — the slug is read from the path. ## `slug` (type: `string`): The status-page slug to use for EVERY source. Leave empty to resolve it automatically per source (from a /status/ path if present, else via GET {base}/api/entry-page → statusPageSlug). Set this when a host serves multiple status pages and /api/entry-page does not resolve the one you want. Example: uptime-kuma (for https://status.kuma.pet). ## `mode` (type: `string`): What to export. 'all' (default): every monitor from the config tree, with latest status / ping / 24h uptime joined from the heartbeat API where available. 'heartbeat': only monitors that have a heartbeat series (status/ping/uptime populated). 'monitors': the monitor tree only — no heartbeat request is made, so status/ping/uptime columns stay empty (fastest, config-only). ## `maxRecords` (type: `integer`): A GLOBAL cap on the number of monitor rows to emit across all sources (each row is one billable event). Defaults to 20 for a cheap, bounded first run; raise it deliberately for larger fleets. ## Actor input object example ```json { "sources": [ "https://status.kuma.pet" ], "mode": "all", "maxRecords": 20 } ``` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "sources": [ "https://status.kuma.pet" ], "maxRecords": 20 }; // Run the Actor and wait for it to finish const run = await client.actor("datamule/uptime-kuma-status-extractor").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "sources": ["https://status.kuma.pet"], "maxRecords": 20, } # Run the Actor and wait for it to finish run = client.actor("datamule/uptime-kuma-status-extractor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "sources": [ "https://status.kuma.pet" ], "maxRecords": 20 }' | apify call datamule/uptime-kuma-status-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=datamule/uptime-kuma-status-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Uptime-Kuma Status Extractor", "description": "Point at any Uptime-Kuma status page and export its monitors, latest status, ping and 24h uptime from the public status-page API. One actor over thousands of self-hosted uptime monitors.", "version": "0.1", "x-build-id": "ooI58vNaeZDmxPpVd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~uptime-kuma-status-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-uptime-kuma-status-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/datamule~uptime-kuma-status-extractor/runs": { "post": { "operationId": "runs-sync-datamule-uptime-kuma-status-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/datamule~uptime-kuma-status-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-uptime-kuma-status-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "sources" ], "properties": { "sources": { "title": "Status page URLs", "type": "array", "description": "One or more Uptime-Kuma status-page base URLs (e.g. https://status.kuma.pet). Every Uptime-Kuma instance exposes the same public JSON API (GET /api/status-page/{slug} + /api/status-page/heartbeat/{slug}), so one actor works against any of them. Give the domain base; the slug is resolved automatically via /api/entry-page, or set the 'slug' input to override. A status-page UI URL like https://host/status/mypage also works — the slug is read from the path.", "default": [ "https://status.kuma.pet" ], "items": { "type": "string" } }, "slug": { "title": "Status page slug (optional)", "type": "string", "description": "The status-page slug to use for EVERY source. Leave empty to resolve it automatically per source (from a /status/ path if present, else via GET {base}/api/entry-page → statusPageSlug). Set this when a host serves multiple status pages and /api/entry-page does not resolve the one you want. Example: uptime-kuma (for https://status.kuma.pet)." }, "mode": { "title": "Mode", "enum": [ "all", "heartbeat", "monitors" ], "type": "string", "description": "What to export. 'all' (default): every monitor from the config tree, with latest status / ping / 24h uptime joined from the heartbeat API where available. 'heartbeat': only monitors that have a heartbeat series (status/ping/uptime populated). 'monitors': the monitor tree only — no heartbeat request is made, so status/ping/uptime columns stay empty (fastest, config-only).", "default": "all" }, "maxRecords": { "title": "Max records (global cap)", "minimum": 1, "type": "integer", "description": "A GLOBAL cap on the number of monitor rows to emit across all sources (each row is one billable event). Defaults to 20 for a cheap, bounded first run; raise it deliberately for larger fleets.", "default": 20 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```