{ "openapi": "3.0.1", "info": { "title": "Outbound Mail Sender Identity Provisioning Gate for Egress IPs", "description": "SPF result for your egress IP, before the first mail. Give it the From domain, the egress IP addresses and the DKIM selectors of a new relay, tenant or email provider. It runs SPF check_host() for each IP (RFC 7208, with lookup counts), checks reverse DNS", "version": "0.1", "x-build-id": "or1mGOmjUQ6U1dmS8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingii98~outbound-mail-sender-identity-provisioning-gate-for-egress-ips/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingii98-outbound-mail-sender-identity-provisioning-gate-for-egress-ips", "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/kingii98~outbound-mail-sender-identity-provisioning-gate-for-egress-ips/runs": { "post": { "operationId": "runs-sync-kingii98-outbound-mail-sender-identity-provisioning-gate-for-egress-ips", "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/kingii98~outbound-mail-sender-identity-provisioning-gate-for-egress-ips/run-sync": { "post": { "operationId": "run-sync-kingii98-outbound-mail-sender-identity-provisioning-gate-for-egress-ips", "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": [ "identities" ], "properties": { "identities": { "title": "Sender identities", "minItems": 1, "maxItems": 50, "type": "array", "description": "1 to 50 sender identities. Each identity is an object with these fields: from_domain (required, the RFC 5322 From domain); egress_ips (required, 1 to 16 public IPv4 or IPv6 addresses of the relay); dkim_selectors (required, 1 to 5 selectors, looked up at ._domainkey.); envelope_domain (optional, the MAIL FROM / Return-Path domain, default from_domain); helo_name (optional, the HELO or EHLO name of the relay); expected_dkim_key_sha256 (optional, an object selector -> SHA-256 of the base64-decoded p= value, in hex or base64). Private and reserved egress addresses are not checked and block the gate.", "default": [ { "from_domain": "github.com", "egress_ips": [ "209.85.220.41" ], "dkim_selectors": [ "google" ], "helo_name": "mail-sor-f41.google.com" }, { "from_domain": "example.com", "egress_ips": [ "8.8.8.8" ], "dkim_selectors": [ "default" ] } ] }, "fail_on": { "title": "Check codes that block the gate", "maxItems": 18, "type": "array", "description": "The check codes that set the gate status to blocked. egress_ip_not_public and dns_lookup_error always block. Known codes: spf_not_pass, spf_lookup_limit_near, spf_not_aligned, dkim_missing, dkim_revoked, dkim_invalid_key, dkim_weak_key, dkim_key_mismatch, dkim_test_mode, ptr_missing, ptr_not_forward_confirmed, ptr_generic, helo_not_resolving, helo_mismatch, dmarc_missing, dmarc_alignment_impossible, egress_ip_not_public, dns_lookup_error.", "default": [ "spf_not_pass", "dkim_missing", "ptr_missing", "ptr_not_forward_confirmed", "dmarc_missing" ], "items": { "type": "string" } } } }, "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 } } } } } } } } } }