--- updatedAt: 2026-05-26T22:41:46.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/edge-dns/llms.txt --- # Run proposed proxy health check for origin name servers Runs a proposed health check on the proxy. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Shield NS53", "version": "v2" }, "openapi": "3.0.0", "paths": { "/proxies/{proxyId}/healthcheck/run-proposed": { "post": { "description": "Runs a proposed health check on the proxy.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/post-run-proposed-proxy-healthcheck" }, "operationId": "post-run-proposed-proxy-healthcheck", "parameters": [ { "description": "The proxy ID you're working with.", "in": "path", "name": "proxyId", "required": true, "schema": { "example": "e585a640-0849-4b87-8dd9-91afdaf8851c", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-id-path.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "healthCheck": { "recordName": "www.customer.com", "recordType": "A" }, "originNameservers": [ { "name": "192.0.2.78", "port": 53 }, { "name": "customer-hostname.customer.com", "port": 53 }, { "name": "192.0.2.90", "port": 53 } ] }, "schema": { "additionalProperties": false, "description": "Request to run a proposed proxy health check against a set of origin name servers.", "properties": { "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "originNameservers": { "description": "List of master name servers to check.", "items": { "additionalProperties": false, "description": "The names or address of the master name servers to protect or transfer from.", "properties": { "name": { "description": "Master name server name or address.", "type": "string" }, "port": { "default": 53, "description": "The master name server port number.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/nameserver-get.yaml" } }, "type": "array" } }, "required": [ "healthCheck", "originNameservers" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-post-run-proposed-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "failures": 3, "healthCheck": { "recordName": "www.customer.com", "recordType": "A" }, "healthcheckResults": [ { "name": "192.0.2.191", "port": 53, "resolved": "192.0.2.136", "responseCode": "NOERROR", "sourceIp": "192.0.2.12" }, { "name": "customer-hostname.customer.com", "port": 53, "resolved": "192.0.2.110", "responseCode": "NXDOMAIN", "sourceIp": "192.0.2.130" }, { "name": "customer-hostname.customer.com", "port": 53, "resolved": "192.0.2.40", "responseCode": "NXDOMAIN", "sourceIp": "192.0.2.95" }, { "name": "192.0.2.121", "port": 53, "resolved": "192.0.2.151", "responseCode": "SERVFAIL", "sourceIp": "192.0.2.46" } ], "proxyActivationStatus": "ACTIVE", "status": "WARNING", "tests": 4 }, "schema": { "additionalProperties": true, "description": "Results of running a proxy health check.", "properties": { "failures": { "description": "Number of failed health check tests.", "type": "integer" }, "healthCheck": { "additionalProperties": false, "description": "The names or addresses of the master name servers to protect.", "properties": { "recordName": { "description": "Name of health check record. A `null` value indicates the record is at the apex of the zone.", "nullable": true, "type": "string" }, "recordType": { "description": "The health check record's DNS record type. Refer to [Supported DNS resource record types](https://techdocs.akamai.com/edge-dns/reference/supported-dns-resource-record-types) for a complete list.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/proxy-healthcheck-get.yaml" } }, "healthcheckResults": { "description": "Health check results.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name or address checked.", "type": "string" }, "port": { "description": "Port used for the health check.", "type": "integer" }, "resolved": { "description": "Resolved IP address.", "type": "string" }, "responseCode": { "description": "A set of DNS response code, any of these values: `NOERROR`, `NXDOMAIN`, and `SERVFAIL`.", "enum": [ "NOERROR", "NXDOMAIN", "SERVFAIL" ], "type": "string" }, "sourceIp": { "description": "Source IP address of the health check.", "type": "string" } }, "required": [ "name", "resolved", "port", "sourceIp", "responseCode" ], "type": "object" }, "type": "array" }, "proxyActivationStatus": { "description": "A set of Proxy activation status, any of these values: `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, and `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "type": "string" }, "status": { "description": "A set of health check status, any of these values: `OK`, `WARNING`, and `ERROR`.", "enum": [ "OK", "WARNING", "ERROR" ], "type": "string" }, "tests": { "description": "Number of health check tests run.", "type": "integer" } }, "required": [ "status", "tests", "failures", "proxyActivationStatus", "healthCheck", "healthcheckResults" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-run-healthcheck.yaml" } } } }, "description": "Successful response." }, "400": { "content": { "application/problem+json": { "example": { "detail": "Invalid value for parameter 'sortBy': 'foo'. Valid values are: name, type.", "instance": "https://problems.luna.akamaiapis.net/authoritative-dns/illegalValue/f804a623-444c-4e4f-a719-2190313b99d7", "problemId": "f804a623-444c-4e4f-a719-2190313b99d7", "status": 400, "title": "Illegal Value", "type": "https://problems.luna.akamaiapis.net/authoritative-dns/illegalValue" }, "schema": { "additionalProperties": true, "description": "An RFC 7807 problem details object returned when an error occurs.", "properties": { "detail": { "description": "A human-readable explanation of the error.", "type": "string" }, "instance": { "description": "A URI that identifies this specific error occurrence.", "type": "string" }, "problemId": { "description": "A unique identifier for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code for this error.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the error.", "type": "string" }, "type": { "description": "A non-navigable URI that uniquely identifies the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Bad Request. The request body is missing a health check definition or origin nameservers." }, "401": { "content": { "application/problem+json": { "example": { "detail": "not logged in", "instance": "https://problems.luna.akamaiapis.net/authoritative-dns/notLoggedIn/f804a623-444c-4e4f-a719-2190313b99d7", "problemId": "f804a623-444c-4e4f-a719-2190313b99d7", "status": 401, "title": "Not Logged In", "type": "https://problems.luna.akamaiapis.net/authoritative-dns/notLoggedIn" }, "schema": { "additionalProperties": true, "description": "An RFC 7807 problem details object returned when an error occurs.", "properties": { "detail": { "description": "A human-readable explanation of the error.", "type": "string" }, "instance": { "description": "A URI that identifies this specific error occurrence.", "type": "string" }, "problemId": { "description": "A unique identifier for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code for this error.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the error.", "type": "string" }, "type": { "description": "A non-navigable URI that uniquely identifies the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Unauthorized. Your credentials are missing or invalid." }, "403": { "content": { "application/problem+json": { "example": { "detail": "Access denied for contract C-0N7RAC7.", "instance": "https://problems.luna.akamaiapis.net/authoritative-dns/forbidden/f804a623-444c-4e4f-a719-2190313b99d7", "problemId": "f804a623-444c-4e4f-a719-2190313b99d7", "status": 403, "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/authoritative-dns/forbidden" }, "schema": { "additionalProperties": true, "description": "An RFC 7807 problem details object returned when an error occurs.", "properties": { "detail": { "description": "A human-readable explanation of the error.", "type": "string" }, "instance": { "description": "A URI that identifies this specific error occurrence.", "type": "string" }, "problemId": { "description": "A unique identifier for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code for this error.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the error.", "type": "string" }, "type": { "description": "A non-navigable URI that uniquely identifies the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Forbidden. You don't have permission to run a health check for this proxy." }, "404": { "content": { "application/problem+json": { "example": { "detail": "Zone not found: example.com.", "instance": "https://problems.luna.akamaiapis.net/authoritative-dns/notFound/f804a623-444c-4e4f-a719-2190313b99d7", "problemId": "f804a623-444c-4e4f-a719-2190313b99d7", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/authoritative-dns/notFound" }, "schema": { "additionalProperties": true, "description": "An RFC 7807 problem details object returned when an error occurs.", "properties": { "detail": { "description": "A human-readable explanation of the error.", "type": "string" }, "instance": { "description": "A URI that identifies this specific error occurrence.", "type": "string" }, "problemId": { "description": "A unique identifier for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code for this error.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the error.", "type": "string" }, "type": { "description": "A non-navigable URI that uniquely identifies the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Not Found. The specified proxy doesn't exist or isn't accessible." }, "415": { "content": { "application/problem+json": { "example": { "detail": "Content type 'text/plain' not supported.", "instance": "https://problems.luna.akamaiapis.net/authoritative-dns/unsupportedMediaType/f804a623-444c-4e4f-a719-2190313b99d7", "problemId": "f804a623-444c-4e4f-a719-2190313b99d7", "status": 415, "title": "Unsupported Media Type", "type": "https://problems.luna.akamaiapis.net/authoritative-dns/unsupportedMediaType" }, "schema": { "additionalProperties": true, "description": "An RFC 7807 problem details object returned when an error occurs.", "properties": { "detail": { "description": "A human-readable explanation of the error.", "type": "string" }, "instance": { "description": "A URI that identifies this specific error occurrence.", "type": "string" }, "problemId": { "description": "A unique identifier for this error occurrence.", "type": "string" }, "status": { "description": "The HTTP status code for this error.", "type": "integer" }, "title": { "description": "A short, human-readable summary of the error.", "type": "string" }, "type": { "description": "A non-navigable URI that uniquely identifies the error type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "Unsupported Media Type. The request's `Content-Type` header is not supported. Use `application/json`." } }, "summary": "Run proposed proxy health check for origin name servers", "tags": [ "DNS proxy health check" ] }, "x-akamai": { "file-path": "paths/proxy-run-proposed-healthcheck.yaml", "path-info": "/proxies/{proxyId}/healthcheck/run-proposed" } } }, "servers": [ { "url": "https://{hostname}/config-dns/v2" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "06-dns-shield.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ``` # Sibling pages * [Run existing proxy health check](https://techdocs.akamai.com/edge-dns/reference/post-run-proxy-healthcheck.md)