{ "openapi": "3.0.1", "info": { "title": "SiteVerdict — Domain & Email Health Checker", "description": "Check SPF, DKIM, DMARC, BIMI, MTA-STS, TLS-RPT, DNSSEC, CAA, SSL certificate expiry, HSTS and security headers for one or thousands of domains. Get a 0-100 score, deliverability risk, plain-English explanations, exact DNS fixes and an HTML report.", "version": "1.0", "x-build-id": "4XH4ZXIVpa6UdFmXD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/siteverdict~siteverdict-domain-email-health/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-domain-email-health", "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/siteverdict~siteverdict-domain-email-health/runs": { "post": { "operationId": "runs-sync-siteverdict-siteverdict-domain-email-health", "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/siteverdict~siteverdict-domain-email-health/run-sync": { "post": { "operationId": "run-sync-siteverdict-siteverdict-domain-email-health", "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": "Domains", "type": "array", "description": "Domains to check, one per line. You can paste bare domains (example.com), URLs (https://www.example.com/page) or email addresses (info@example.com); they are normalised and de-duplicated.", "items": { "type": "string" } }, "domainsListUrl": { "title": "Domain list URL (bulk)", "type": "string", "description": "Optional URL of a plain-text or CSV file with one domain per line (first column is used). Handy for agencies checking thousands of client domains." }, "maxDomains": { "title": "Max domains", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety cap on the number of domains processed in one run.", "default": 10000 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many domains are checked in parallel. 10 is fast and polite; raise to 25-50 for large lists.", "default": 10 }, "delayBetweenDomainsMs": { "title": "Delay per worker between domains (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Optional pause after each domain, per worker. Use for extra-gentle rate limiting.", "default": 0 }, "skipChecks": { "title": "Skip checks", "type": "array", "description": "Checks to leave out (skipped checks are excluded from the score).", "items": { "type": "string", "enum": [ "mx", "spf", "dmarc", "dkim", "mtaSts", "tlsRpt", "bimi", "ssl", "sslWww", "httpsRedirect", "hsts", "securityHeaders", "dnssec", "caa", "ns" ], "enumTitles": [ "MX", "SPF", "DMARC", "DKIM", "MTA-STS", "TLS-RPT", "BIMI", "SSL (apex)", "SSL (www)", "HTTP to HTTPS redirect", "HSTS", "Security headers", "DNSSEC", "CAA", "Nameservers" ] }, "default": [] }, "dkimSelectors": { "title": "DKIM selectors to probe", "type": "array", "description": "DKIM selectors cannot be listed via DNS, so common ones are probed. Leave empty to use the built-in list (google, selector1, selector2, k1, s1, s2, default, mandrill, smtpapi, zoho, mxvault, cf2024-1 and ~30 more).", "items": { "type": "string" } }, "extraDkimSelectors": { "title": "Extra DKIM selectors", "type": "array", "description": "Additional selectors to probe on top of the list above (e.g. the s= value from a DKIM-Signature header in one of your emails).", "items": { "type": "string" } }, "checkWww": { "title": "Also check www. certificate", "type": "boolean", "description": "Run the SSL/TLS check on www. as well as the apex.", "default": true }, "stripWww": { "title": "Strip leading www.", "type": "boolean", "description": "Treat www.example.com as example.com (email records live on the apex).", "default": true }, "checkHstsPreloadList": { "title": "Query hstspreload.org status", "type": "boolean", "description": "Also ask the public hstspreload.org API whether the domain is on the Chrome HSTS preload list. Off by default to keep runs fully self-contained.", "default": false }, "checkBlocklists": { "title": "Check DNS blocklists (opt-in)", "type": "boolean", "description": "Look up MX server IPs on DNS blocklists. OFF by default. Blocklist operators set their own usage terms: the default lists (SpamCop, PSBL, DroneBL) allow free low-volume queries. Spamhaus, URIBL, SURBL and Barracuda restrict commercial use or require a registered key; only add them if your use complies with their terms.", "default": false }, "dnsblZones": { "title": "Blocklist zones", "type": "array", "description": "DNSBL zones to query when blocklist checks are enabled. Zones containing 'dbl' / 'uribl' / 'surbl' are queried with the domain name; others with MX IPs.", "items": { "type": "string" } }, "smtpStarttlsCheck": { "title": "SMTP STARTTLS probe (opt-in)", "type": "boolean", "description": "Connect to the primary MX on port 25, send EHLO, read the capability list and QUIT. No email is sent, no authentication or relay test is attempted. Off by default; port 25 is often blocked on cloud networks.", "default": false }, "dnsResolver": { "title": "DNS resolver", "enum": [ "cloudflare", "google", "quad9", "system", "doh" ], "type": "string", "description": "Recursive resolver used for lookups. Falls back to DNS-over-HTTPS (Cloudflare, then Google) on errors.", "default": "cloudflare" }, "dohFallback": { "title": "DNS-over-HTTPS fallback", "type": "boolean", "description": "Retry failed lookups over DNS-over-HTTPS.", "default": true }, "timeoutSecs": { "title": "Network timeout (seconds)", "minimum": 2, "maximum": 30, "type": "integer", "description": "Timeout for each DNS/TLS/HTTP operation.", "default": 6 }, "domainTimeoutSecs": { "title": "Per-domain timeout (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "Hard limit for all checks of one domain.", "default": 45 }, "htmlReport": { "title": "Generate HTML report", "type": "boolean", "description": "Save a combined HTML report (key-value store record REPORT).", "default": true }, "perDomainHtmlReports": { "title": "Per-domain HTML reports", "type": "boolean", "description": "Also save one shareable HTML report per domain (record report-); its URL is in each dataset item.", "default": true }, "maxDetailedInSummary": { "title": "Detailed domains in combined report", "minimum": 0, "maximum": 2000, "type": "integer", "description": "How many of the lowest-scoring domains get full detail in the combined report (all domains appear in the summary table).", "default": 100 } } }, "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 } } } } } } } } } }