{ "openapi": "3.1.0", "info": { "title": "Deliverlens diagnostics API", "version": "1.0.0", "description": "Customer diagnostics used by Deliverlens MCP. Built by Fintrate LTD. Existing API access, scopes, shared allowances and provider availability apply." }, "servers": [ { "url": "https://api.deliverlens.com" } ], "paths": { "/api/v1/account/services": { "get": { "operationId": "list_services", "summary": "Available services and allowances", "description": "Get this account\u2019s service availability, plan allowances and remaining usage before running a check.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:read", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "404": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "410": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } } } }, "/api/v1/account/service-runs/{checkRun}": { "get": { "operationId": "get_check_result", "summary": "Read a check result", "description": "Read an owned check by ID. Queued or running means the result is not ready. This read does not start another check.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:read", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "404": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "410": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "parameters": [ { "name": "checkRun", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The ID returned by the corresponding creation tool for this account." } } ] } }, "/api/v1/account/tests": { "post": { "operationId": "create_message_test", "summary": "Create a message test", "description": "Create a test email address using the account\u2019s existing message-test allowance. Ask before consuming a test. The user must send their message to the returned address.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "tests:create", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." } }, "required": [ "request_id" ], "additionalProperties": false } } } } } }, "/api/v1/account/tests/{test}": { "get": { "operationId": "get_message_test", "summary": "Read a message test", "description": "Read an owned message test by ID. Waiting means no analysed message is ready. Return the actual evidence and avoid promises about inbox delivery.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "tests:read", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "404": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "410": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "parameters": [ { "name": "test", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The ID returned by the corresponding creation tool for this account." } } ] } }, "/api/v1/account/services/email-verifier/runs": { "post": { "operationId": "check_email", "summary": "Email Verifier", "description": "Check an email address for formatting problems and confirm whether its domain is set up to receive email. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "Email address to check, with a public DNS domain." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/spf-checker/runs": { "post": { "operationId": "check_spf", "summary": "SPF Checker", "description": "Find a domain\u2019s SPF record and spot common configuration problems. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "A public DNS domain, for example fintrate.com. Do not include a URL or path." }, "sending_ip": { "type": "string", "maxLength": 45, "description": "Optional public sending IP for an SPF evaluation." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/dkim-checker/runs": { "post": { "operationId": "check_dkim", "summary": "DKIM Checker", "description": "Look up a DKIM public key and check whether its selector and key material are published correctly. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "A public DNS domain, for example fintrate.com. Do not include a URL or path." }, "selector": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Published selector. DKIM requires the selector from a signed message; BIMI defaults to default." } }, "required": [ "request_id", "target", "selector" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/dmarc-checker/runs": { "post": { "operationId": "check_dmarc", "summary": "DMARC Checker", "description": "Find a DMARC record, review its policy and alignment settings, and catch common mistakes. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "A public DNS domain, for example fintrate.com. Do not include a URL or path." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/bimi-checker/runs": { "post": { "operationId": "check_bimi", "summary": "BIMI Checker", "description": "Check whether a BIMI record is published and review its declared logo and certificate locations. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "A public DNS domain, for example fintrate.com. Do not include a URL or path." }, "selector": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Published selector. DKIM requires the selector from a signed message; BIMI defaults to default." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/domain-blacklist-checker/runs": { "post": { "operationId": "check_domain_blacklist", "summary": "Domain Blacklist Checker", "description": "Check whether a domain appears on the reputation sources connected to Deliverlens. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "A public DNS domain, for example fintrate.com. Do not include a URL or path." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/email-blacklist-checker/runs": { "post": { "operationId": "check_email_blacklist", "summary": "Email Blacklist Checker", "description": "Review the reputation coverage available for an email address and see whether it applies to the address or its domain. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "Email address to check, with a public DNS domain." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/ip-blacklist-checker/runs": { "post": { "operationId": "check_ip_blacklist", "summary": "IP Blacklist Checker", "description": "Check a public sending IP against the reputation sources connected to Deliverlens. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "target": { "type": "string", "minLength": 1, "maxLength": 254, "description": "A public IPv4 or IPv6 address." } }, "required": [ "request_id", "target" ], "additionalProperties": false } } } } } }, "/api/v1/account/services/inbox-placement/runs": { "post": { "operationId": "start_inbox_placement", "summary": "Inbox Placement", "description": "See where a controlled test email lands across the connected mailbox sample. Starts a queued check and uses the current service allowance. Read it with get_check_result. Check availability with list_services first.", "security": [ { "bearerAuth": [] } ], "x-api-key-ability": "services:run", "responses": { "200": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "201": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "202": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "401": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "402": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "403": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "409": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "422": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "429": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." }, "503": { "description": "Existing Deliverlens API response. Errors contain a message; success responses contain data." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "A new random 64-character lowercase hexadecimal idempotency identifier. Reuse it only when retrying the same operation." }, "from_email": { "type": "string", "minLength": 1, "maxLength": 254 }, "subject": { "type": "string", "minLength": 1, "maxLength": 200 }, "campaign": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "request_id", "from_email", "subject", "campaign" ], "additionalProperties": false } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A named, unexpired Deliverlens integration API key. Never use a frontend or session credential." } } }, "externalDocs": { "description": "MCP transport uses the same account controls", "url": "https://api.deliverlens.com/mcp" } }