{
"openapi": "3.0.1",
"info": {
"title": "Email Security Check: SPF, DKIM, DMARC, MX",
"description": "Audit SPF (with its DNS lookup count), DMARC, DKIM key sizes, MTA-STS, TLS-RPT, BIMI and MX for a list of domains. Get a grade from A to F, issues with exact fixes, and a Google/Yahoo bulk sender check. Optional monitoring with change alerts.",
"version": "0.1",
"x-build-id": "JxzR0L2dR6qbTZloW"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/fernandosord~email-security-audit-spf-dkim-dmarc/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-fernandosord-email-security-audit-spf-dkim-dmarc",
"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/fernandosord~email-security-audit-spf-dkim-dmarc/runs": {
"post": {
"operationId": "runs-sync-fernandosord-email-security-audit-spf-dkim-dmarc",
"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/fernandosord~email-security-audit-spf-dkim-dmarc/run-sync": {
"post": {
"operationId": "run-sync-fernandosord-email-security-audit-spf-dkim-dmarc",
"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": [
"domains"
],
"properties": {
"domains": {
"title": "Domains",
"type": "array",
"description": "Domains to audit, one per line, such as yourcompany.com or a sending subdomain like mail.yourcompany.com. URLs and email addresses are accepted and reduced to the domain; a leading www. is dropped. Up to 5,000 per run.",
"items": {
"type": "string"
}
},
"dkimSelectors": {
"title": "Extra DKIM selectors",
"type": "array",
"description": "DKIM keys can only be found by name. 52 common selectors (google, selector1, selector2, k1, s1, default and others) are always checked. Add your own here: it is the s= value in the DKIM-Signature header of a message you sent. Up to 20.",
"items": {
"type": "string"
}
},
"checkDnssec": {
"title": "Check DNSSEC",
"type": "boolean",
"description": "Ask Google Public DNS (dns.google) whether the domain's answers are DNSSEC-validated and whether a DS record exists. Informational: it does not change the grade.",
"default": true
},
"stateKey": {
"title": "Monitoring list name",
"type": "string",
"description": "Turn on monitoring mode: each domain's result is saved under this name, and later runs with the same name report what changed (grade, SPF, DMARC, DKIM keys, MX, MTA-STS, new and resolved issues). Leave empty for a one-off audit. Use a different name per client or list."
},
"webhookUrl": {
"title": "Webhook URL",
"type": "string",
"description": "Optional, monitoring mode only. An https:// URL that receives a POST when at least one domain changed: a Slack or Discord incoming webhook, or any endpoint that accepts JSON."
},
"webhookFormat": {
"title": "Webhook format",
"enum": [
"json",
"slack",
"discord"
],
"type": "string",
"description": "slack and discord send a short text message; json sends the list of changes.",
"default": "json"
},
"respectRobotsTxt": {
"title": "Respect robots.txt",
"type": "boolean",
"description": "Applies to the one web request this Actor makes: the MTA-STS policy file at https://mta-sts.<domain>/.well-known/mta-sts.txt. Everything else is DNS.",
"default": true
},
"maxConcurrency": {
"title": "Domains checked at once",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many domains are audited in parallel. Each domain takes about 80 DNS queries to public resolvers, so higher values can hit their rate limits.",
"default": 5
},
"timeoutSecs": {
"title": "Request timeout",
"minimum": 5,
"maximum": 60,
"type": "integer",
"description": "How long to wait for the MTA-STS policy file. DNS queries have their own limit of a few seconds.",
"default": 15
}
}
},
"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
}
}
}
}
}
}
}
}
}
}