{ "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 } } } } } } } } } }