{ "openapi": "3.0.1", "info": { "title": "🛡️ Data Breach Monitor - New Breach Alerts by Domain", "description": "⚡ Know the day a new data breach is published. ✅ Watches the Have I Been Pwned breach catalogue and reports only what is new. ✅ Filter by company domain, exposed data type or size. No API key required — uses the public catalogue endpoint.", "version": "1.0", "x-build-id": "3Nl68w2z6IWiiu163" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~breach-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-breach-monitor", "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/that_red_bird~breach-monitor/runs": { "post": { "operationId": "runs-sync-that_red_bird-breach-monitor", "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/that_red_bird~breach-monitor/run-sync": { "post": { "operationId": "run-sync-that_red_bird-breach-monitor", "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", "properties": { "domains": { "title": "Only breaches at these domains", "type": "array", "description": "Partial match on the breached company's domain, e.g. adobe.com. Leave empty to watch every new breach.", "items": { "type": "string" } }, "keywords": { "title": "Only breaches matching", "type": "array", "description": "Case-insensitive match on the breach title, domain and description.", "items": { "type": "string" } }, "dataClasses": { "title": "Only these data types", "type": "array", "description": "Match breaches exposing these data classes, e.g. Passwords, Credit cards, Physical addresses.", "items": { "type": "string" } }, "minAccounts": { "title": "Minimum accounts affected", "type": "integer", "description": "Ignore breaches smaller than this." }, "verifiedOnly": { "title": "Verified breaches only", "type": "boolean", "description": "Skip breaches HIBP has not verified.", "default": false }, "onlyNew": { "title": "Only report breaches never seen before", "type": "boolean", "description": "Keeps a ledger of announced breach ids. The first run records a baseline silently rather than announcing the entire historical catalogue.", "default": true }, "resetBaseline": { "title": "Reset baseline", "type": "boolean", "description": "Clear the seen-breach ledger and start fresh.", "default": false }, "baselineSampleSize": { "title": "Baseline sample size", "minimum": 0, "maximum": 100, "type": "integer", "description": "On the first run (no ledger yet), how many of the currently-matching breaches to include as a labelled sample (isBaseline: true) alongside the summary row, so the dataset is never empty.", "default": 10 }, "maxItems": { "title": "Max output rows", "minimum": 0, "type": "integer", "description": "Hard cap on dataset rows per run. 0 = no cap.", "default": 0 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POSTed when new breaches appear. Slack/Discord/Zapier compatible." }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store holding the seen-breach ledger.", "default": "breach-monitor-state" } } }, "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 } } } } } } } } } }