# Gatus Status Extractor (`datamule/gatus-status-extractor`) Actor Point at any self-hosted Gatus status page and export its monitored endpoints and health-check history from the public /api/v1/endpoints/statuses JSON: status code, response time, per-condition pass/fail, success and timestamp. - **URL**: https://apify.com/datamule/gatus-status-extractor.md - **Developed by:** [Datamule](https://apify.com/datamule) (community) - **Categories:** Developer tools - **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.35 / 1,000 results 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 ## Gatus Status Extractor **Point at any self-hosted [Gatus](https://github.com/TwiN/gatus) status page and export its monitored endpoints and health-check history as clean, structured rows.** Gatus is a hugely popular self-hosted health-dashboard / status-page. Every Gatus instance — regardless of version or configuration — exposes the **identical public JSON endpoint** `GET /api/v1/endpoints/statuses`: a list of monitored endpoints, each with its recent result history (HTTP status, response time, per-condition pass/fail, success flag and timestamp). This actor speaks that one standard, so **a single actor works against every Gatus instance in existence** — no per-host scraper. Give it a status page URL; get back a flat, fully-typed dataset row for every health-check result (or one row per endpoint), ready for a spreadsheet, a database, an uptime/SLA report or an observability pipeline. > **Gatus only.** [Uptime-Kuma](https://github.com/louislam/uptime-kuma) and other self-hosted status pages use a different API and are **not** supported by this actor. ### Try it now ```json {"statusPageUrl":"https://status.twin.sh","latestResultOnly":false,"listEndpointsOnly":false,"maxRecords":25,"maxHistoryPages":1,"pageSize":25} ```` This bounded history run reads the freshest page and emits at most 25 rows. The global default is also 25 rows when `maxRecords` is omitted, unparsable, boolean, zero or negative. Any explicit positive cap, including a higher one, is preserved. ### What it does - **Any Gatus instance, one input.** Pass a bare base (`https://status.twin.sh`) or the full `.../api/v1/endpoints/statuses` URL — both are normalized. - **Three modes.** - **Full history** (default) — one row per *(endpoint × result)*, exporting the recent result history Gatus keeps. - **Latest only** (`latestResultOnly`) — one row per endpoint, using only its most-recent result. - **Discovery** (`listEndpointsOnly`) — one lightweight row per endpoint (name, group, key, latest status/success, result count); a fast way to enumerate what a page monitors. - **Reads by key presence.** Gatus instances differ only in which optional fields they populate. A non-HTTP check (TCP/ICMP/DNS) with no `status`, an endpoint with no `group` or `hostname`, a not-yet-run endpoint with no results — every one yields `null` / `[]` for that column, never an error. - **History pagination, done right.** Gatus paginates each endpoint's `results[]` via `?page=N&pageSize=M` (newest first). Set `maxHistoryPages` to walk further back; paging stops automatically once a page contributes no new results. ### Input | Field | Required | Description | |---|---|---| | `statusPageUrl` | ✅ | A Gatus base (`https://status.twin.sh`) **or** a full `/api/v1/endpoints/statuses` URL. | | `latestResultOnly` | | One row per endpoint using only its most-recent result. Default `false`. | | `listEndpointsOnly` | | Discovery mode: one row per endpoint, no history. Overrides `latestResultOnly`. | | `groupFilter` | | Case-insensitive substring matched against each endpoint's **group**. | | `nameFilter` | | Case-insensitive substring matched against each endpoint's **name**. | | `maxRecords` | | Global cap on emitted rows (default `25`; each row is one billable `result` event). Any explicit positive cap is allowed. | | `maxHistoryPages` | | How many pages of result history to walk (default `1`, max `50`). Ignored in latest/discovery mode. | | `pageSize` | | Results per endpoint per page (default `100`; Gatus caps at 100). | | `bearer` | | Bearer token for a gated instance. Never logged. | | `extraHeaders` | | Extra HTTP headers as a JSON object for a gated page. Never logged. | #### Other example inputs ```json { "statusPageUrl": "https://status.twin.sh", "latestResultOnly": true, "groupFilter": "core" } ``` ```json { "statusPageUrl": "https://status.twin.sh", "listEndpointsOnly": true } ``` ### Output One row per *(endpoint, result)* — or per endpoint in latest/discovery mode: | Column | Description | |---|---| | `endpointName` | The monitored endpoint's name (e.g. `blog-home`). | | `group` | The endpoint's group, when Gatus groups it (e.g. `core`). | | `key` | Gatus's stable key for the endpoint (e.g. `core_blog-home`). | | `status` | HTTP status code. `null` for a non-HTTP check (TCP/ICMP/DNS). | | `hostname` | Resolved hostname of the check, when present. | | `durationMs` | Response time in **milliseconds** (Gatus's nanosecond `duration`, converted). | | `success` | Whether the check passed overall. | | `timestamp` | Result timestamp (ISO-8601). | | `conditionCount` / `conditionsPassed` / `conditionsFailed` | Per-condition pass/fail tally for the result. | | `firstFailedCondition` | The condition string of the first failed condition (e.g. `[STATUS] == 200`), else `null`. | | `errors` | Array of error strings the check recorded, when present. | | `latestStatus` / `latestSuccess` / `resultCount` | *(Discovery mode)* the endpoint's most-recent status/success and how many results the freshest page held. | | `_raw` | The complete original result object — nothing is ever dropped (raw nanosecond `duration`, full `conditionResults`, …). | | `_source` / `_endpointCount` | The exact statuses URL and how many endpoints the page monitors. | Every field is **nullable** and read by key presence — a Gatus instance that omits `group` / `hostname` / `status` / `errors` simply yields `null` for that column, never an error. #### Representative result This genuine row was captured from `https://status.twin.sh`. Its endpoint identity and field types are representative; the timestamp and duration are naturally volatile. ```json { "_type": "result", "_source": "https://status.twin.sh/api/v1/endpoints/statuses", "_endpointCount": 10, "endpointName": "blog-article-43", "group": "core", "key": "core_blog-article-43", "status": 200, "hostname": "blog.default.svc.cluster.local", "durationMs": 1.705845, "success": true, "timestamp": "2026-07-20T23:41:30.698756205Z", "conditionCount": 5, "conditionsPassed": 5, "conditionsFailed": 0, "firstFailedCondition": null, "errors": null, "latestStatus": null, "latestSuccess": null, "resultCount": null, "_raw": { "status": 200, "success": true, "duration": 1705845, "hostname": "blog.default.svc.cluster.local", "timestamp": "2026-07-20T23:41:30.698756205Z", "conditionResults": [ {"condition": "[STATUS] == 200", "success": true}, {"condition": "[BODY].id == 43", "success": true}, {"condition": "[BODY].title == Writing a Simple Reverse Proxy in Go", "success": true}, {"condition": "[BODY].creationDate == 2020-04-18", "success": true}, {"condition": "len([BODY].tags) == 3", "success": true} ] } } ``` ### Notes & scope - **Point-in-time freshness.** Each run reads the status and retained history that the Gatus instance exposes at that moment; this actor does not monitor continuously or reconstruct history the source no longer retains. - **Bounded coverage.** The default run reads one page and emits at most 25 rows globally. Increase `maxHistoryPages`, `pageSize` and an explicit positive `maxRecords` when you intentionally need deeper source-retained history. - **Public or supplied-auth status data only.** This reads the same `statuses` JSON the dashboard renders. It does not discover private credentials or data outside that endpoint. - **Find instances.** Any public Gatus status page works; the demo instance at `https://status.twin.sh` is a good place to try it. ### Troubleshooting - **Wrong base, HTML or a non-array response:** pass the Gatus base URL or its full `/api/v1/endpoints/statuses` URL. The actor appends the endpoint path and expects a top-level JSON array; an HTML login/error page, 404 body, JSON object or a different status-page product fails fast. - **Authentication errors:** set `bearer` or the required values in `extraHeaders`. Confirm those credentials can fetch `/api/v1/endpoints/statuses` directly; secret values are never logged. - **Filters or zero rows:** clear `groupFilter` / `nameFilter` and retry the bounded input above. A valid page with no endpoints, no recent results, or no filter matches returns 0 rows cleanly; discovery mode can confirm which endpoint names and groups exist. ### Pricing Pay-per-event: **$0.0005 per `result` row** returned. At the default global cap of 25 rows, the maximum FREE-tier event charge is **$0.0125** (`25 × $0.0005`). Apify infrastructure usage is excluded. A run charges only for rows it actually emits; an explicit higher positive cap can raise that event charge. # Actor input Schema ## `statusPageUrl` (type: `string`): A Gatus status page. Every Gatus instance exposes the identical public JSON endpoint GET {base}/api/v1/endpoints/statuses, so one actor works against any of them. Give either the bare base (https://status.twin.sh) or the full statuses URL (https://status.twin.sh/api/v1/endpoints/statuses) — both are normalized. This is Gatus ONLY (github.com/TwiN/gatus); Uptime-Kuma and other status-page products use a different API and are not supported. ## `latestResultOnly` (type: `boolean`): When true, emit ONE row per monitored endpoint using only its most-recent health-check result. When false (default), emit one row per (endpoint x result) so the full recent result history Gatus keeps is exported. ## `listEndpointsOnly` (type: `boolean`): Discovery mode: emit one lightweight row per monitored endpoint (name, group, key, latestStatus, latestSuccess, resultCount) and no per-result history. Useful to enumerate what a status page monitors before pulling full history. Overrides latestResultOnly. ## `groupFilter` (type: `string`): Optional case-insensitive substring matched against each endpoint's group; endpoints whose group does not contain it are skipped. Gatus groups related endpoints (e.g. core, misc, external). Leave empty to include every group. ## `nameFilter` (type: `string`): Optional case-insensitive substring matched against each endpoint's name; endpoints whose name does not contain it are skipped. Leave empty to include every endpoint. Example: blog (matches blog-home, blog-external, ...). ## `maxRecords` (type: `integer`): A GLOBAL 25-row default cap on emitted rows (each emitted row is one billable result event). Set any explicit positive cap, including a higher value, when you need more rows. ## `maxHistoryPages` (type: `integer`): How many pages of result history to walk (Gatus paginates each endpoint's results\[] via ?page=N\&pageSize=M, newest page first). Default 1 = only the freshest page the server returns (up to ~100 results per endpoint). Increase to reach further back into history. Ignored in discovery mode. Pagination stops early once a page contributes no new results. ## `pageSize` (type: `integer`): The pageSize passed to Gatus (results per endpoint per page). Gatus caps this at 100. Default 100 to pull the most history per request. ## `bearer` (type: `string`): Optional bearer token for a Gatus instance behind auth (sent as Authorization: Bearer \*\*\*). Not required for public status pages. Never logged. ## `extraHeaders` (type: `object`): Optional extra HTTP headers as a JSON object, e.g. {"x-api-key": "..."} or a cookie for a gated status page. Not required for public pages. Header values are never logged. ## Actor input object example ```json { "statusPageUrl": "https://status.twin.sh", "latestResultOnly": false, "listEndpointsOnly": false, "maxRecords": 25, "maxHistoryPages": 1, "pageSize": 100 } ``` # 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 = { "statusPageUrl": "https://status.twin.sh", "maxRecords": 25 }; // Run the Actor and wait for it to finish const run = await client.actor("datamule/gatus-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 = { "statusPageUrl": "https://status.twin.sh", "maxRecords": 25, } # Run the Actor and wait for it to finish run = client.actor("datamule/gatus-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 '{ "statusPageUrl": "https://status.twin.sh", "maxRecords": 25 }' | apify call datamule/gatus-status-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=datamule/gatus-status-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Gatus Status Extractor", "description": "Point at any self-hosted Gatus status page and export its monitored endpoints and health-check history from the public /api/v1/endpoints/statuses JSON: status code, response time, per-condition pass/fail, success and timestamp.", "version": "0.1", "x-build-id": "9gWDQe5vdb6x8bZ7z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~gatus-status-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-gatus-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~gatus-status-extractor/runs": { "post": { "operationId": "runs-sync-datamule-gatus-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~gatus-status-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-gatus-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": [ "statusPageUrl" ], "properties": { "statusPageUrl": { "title": "Gatus status page URL", "type": "string", "description": "A Gatus status page. Every Gatus instance exposes the identical public JSON endpoint GET {base}/api/v1/endpoints/statuses, so one actor works against any of them. Give either the bare base (https://status.twin.sh) or the full statuses URL (https://status.twin.sh/api/v1/endpoints/statuses) — both are normalized. This is Gatus ONLY (github.com/TwiN/gatus); Uptime-Kuma and other status-page products use a different API and are not supported." }, "latestResultOnly": { "title": "Latest result only (one row per endpoint)", "type": "boolean", "description": "When true, emit ONE row per monitored endpoint using only its most-recent health-check result. When false (default), emit one row per (endpoint x result) so the full recent result history Gatus keeps is exported.", "default": false }, "listEndpointsOnly": { "title": "Discovery mode (list endpoints only)", "type": "boolean", "description": "Discovery mode: emit one lightweight row per monitored endpoint (name, group, key, latestStatus, latestSuccess, resultCount) and no per-result history. Useful to enumerate what a status page monitors before pulling full history. Overrides latestResultOnly.", "default": false }, "groupFilter": { "title": "Group filter (substring)", "type": "string", "description": "Optional case-insensitive substring matched against each endpoint's group; endpoints whose group does not contain it are skipped. Gatus groups related endpoints (e.g. core, misc, external). Leave empty to include every group." }, "nameFilter": { "title": "Endpoint name filter (substring)", "type": "string", "description": "Optional case-insensitive substring matched against each endpoint's name; endpoints whose name does not contain it are skipped. Leave empty to include every endpoint. Example: blog (matches blog-home, blog-external, ...)." }, "maxRecords": { "title": "Max records (global cap)", "minimum": 1, "type": "integer", "description": "A GLOBAL 25-row default cap on emitted rows (each emitted row is one billable result event). Set any explicit positive cap, including a higher value, when you need more rows.", "default": 25 }, "maxHistoryPages": { "title": "Max history pages per fetch", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many pages of result history to walk (Gatus paginates each endpoint's results[] via ?page=N&pageSize=M, newest page first). Default 1 = only the freshest page the server returns (up to ~100 results per endpoint). Increase to reach further back into history. Ignored in discovery mode. Pagination stops early once a page contributes no new results.", "default": 1 }, "pageSize": { "title": "Results page size", "minimum": 1, "maximum": 100, "type": "integer", "description": "The pageSize passed to Gatus (results per endpoint per page). Gatus caps this at 100. Default 100 to pull the most history per request.", "default": 100 }, "bearer": { "title": "Bearer token", "type": "string", "description": "Optional bearer token for a Gatus instance behind auth (sent as Authorization: Bearer ***). Not required for public status pages. Never logged." }, "extraHeaders": { "title": "Extra request headers", "type": "object", "description": "Optional extra HTTP headers as a JSON object, e.g. {\"x-api-key\": \"...\"} or a cookie for a gated status page. Not required for public pages. Header values are never logged." } } }, "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 } } } } } } } } } } ```