{ "openapi": "3.0.1", "info": { "title": "Broken Link Checker & Bulk URL Status Code Checker", "description": "Check the HTTP status of thousands of URLs, or crawl a site and test every link on it. Status code, full redirect chain, final URL, response time, error type (DNS, SSL, timeout, 4xx, 5xx) and the page each broken link sits on. HEAD with GET fallback, polite per-domain limits.", "version": "0.1", "x-build-id": "79QTqZ1treubqo2n8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kilndata~broken-link-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kilndata-broken-link-checker", "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/kilndata~broken-link-checker/runs": { "post": { "operationId": "runs-sync-kilndata-broken-link-checker", "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/kilndata~broken-link-checker/run-sync": { "post": { "operationId": "run-sync-kilndata-broken-link-checker", "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": [ "urls" ], "properties": { "urls": { "title": "URLs or websites", "type": "array", "description": "One per line. In \"List\" mode each line is checked as it is. In \"Crawl\" mode each line is a page to start from (usually a home page). A missing https:// is added. Duplicates are removed. Public http(s) addresses only.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "list", "crawl" ], "type": "string", "description": "\"List\" checks exactly the URLs you gave. \"Crawl\" opens each page you gave (and internal pages up to the depth below), then checks every link on them and tells you on which page each link was found.", "default": "list" }, "maxDepth": { "title": "Crawl depth", "minimum": 0, "maximum": 10, "type": "integer", "description": "Crawl mode only. 0 = open only the page you gave and check its links. 1 = also open the internal pages it links to, and check their links. Pages deeper than this are checked for status but not opened.", "default": 1 }, "maxPagesPerSite": { "title": "Max pages to open per site", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Crawl mode only. How many pages of one website are opened to read their links. Links found on them are all checked.", "default": 50 }, "checkExternal": { "title": "Check external links", "type": "boolean", "description": "Crawl mode only. Also check links that lead to other websites. They are only checked, never opened. Turn off to test internal links only.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Crawl mode only. Pages and internal links that robots.txt disallows are not requested (they come back as \"skipped\", free). External links are only status-checked with HEAD/GET and do not read the other site's robots.txt.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many requests run at the same time in total, across all domains.", "default": 10 }, "perDomainConcurrency": { "title": "Parallel requests per domain", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests may hit the same domain at once. Keep it low: this is what keeps other people's servers safe.", "default": 2 }, "perDomainDelayMs": { "title": "Minimum gap between requests to one domain (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between two requests to the same domain. After a 429 answer the domain is slowed down further.", "default": 200 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 3, "maximum": 120, "type": "integer", "description": "How long to wait for one answer before it counts as a timeout. Timeouts are reported but not billed.", "default": 20 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for timeouts, connection resets, 429 and 5xx answers. DNS failures, SSL errors and 4xx answers are never retried.", "default": 2 }, "userAgent": { "title": "User-Agent", "type": "string", "description": "Optional. Leave empty to use the default, which says clearly that this is a link checker (BrokenLinkCheckerBot/1.0). Change it only if you own the sites you check.", "default": "" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }