--- updatedAt: 2026-05-26T22:41:46.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/edge-dns/llms.txt --- # List proxies for a TSIG key List proxies that use a TSIG key. # 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}/zones/{name}/key/used-by": { "get": { "description": "List proxies that use a TSIG key.", "externalDocs": { "description": "See documentation for this operation in Akamai's Edge DNS API", "url": "https://techdocs.akamai.com/edge-dns/reference/get-proxies-key-used-by" }, "operationId": "get-proxies-key-used-by", "parameters": [ { "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "activationState": "ACTIVE", "authorities": [ "192.0.2.161", "2001:db8:6b4e:3234:365e:6afe:54d6:9b32" ], "authoritiesDnsNames": [ "c1-25.akashield.net", "c2-30.akashield.net" ], "contractId": "C-0N7RAC7", "createdTime": "2024-12-20T00:00:00Z", "ecsSetting": true, "fullIpPassthroughEnabled": false, "healthCheck": { "recordName": "example.com", "recordType": "SOA" }, "id": "dc33c6bf-801c-577d-b6f7-d9a058eaa7db", "lastModifiedTime": "2024-12-24T00:00:00Z", "name": "Rivers Shields", "originNameserverZoneTransferTargets": [ "192.0.2.167", "192.0.2.254" ], "originNameservers": [ { "name": "192.0.2.4", "port": 53 } ], "zoneTransferNameservers": [ { "name": "192.0.2.167", "port": 53 }, { "name": "192.0.2.254", "port": 53 } ] }, { "activationState": "NEW", "authorities": [], "contractId": "C-0N7RAC71", "createdTime": "2024-12-18T00:00:00Z", "healthCheck": { "recordName": "example.net", "recordType": "TXT" }, "id": "6ef0340d-5b93-4a9a-8fc3-0f3ba26f7443", "lastModifiedTime": "2024-12-18T00:00:00Z", "name": "Oceans Proxy", "originNameserverZoneTransferTargets": [], "originNameservers": [ { "name": "192.0.2.135", "port": 443 } ], "zoneTransferNameservers": [] } ] }, "schema": { "additionalProperties": false, "properties": { "items": { "description": "Proxies response.", "items": { "additionalProperties": false, "description": "A Proxy.", "properties": { "activationState": { "description": "__Read-only__ The current proxy activation status. Either `NEW`, `PENDING`, `ACTIVE`, `LOCKED`, `DELETED`, or `ERROR`.", "enum": [ "NEW", "PENDING", "ACTIVE", "LOCKED", "DELETED", "ERROR" ], "readOnly": true, "type": "string" }, "activeHealthcheck": { "additionalProperties": false, "description": "Active health check settings for the proxy.", "properties": { "enabled": { "description": "Whether active health checks are enabled. When `true`, `interval` and `limit` can't both be `0`.", "type": "boolean" }, "interval": { "description": "The interval in seconds between health checks. Specify `0` to disable interval-based checking, or a value between `10` and `3600`.", "maximum": 3600, "minimum": 0, "type": "integer" }, "limit": { "description": "The number of consecutive health check failures before the proxy considers a zone unhealthy. Specify a value between `0` and `100`.", "maximum": 100, "minimum": 0, "type": "integer" } }, "required": [ "enabled", "interval", "limit" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-active-healthcheck-get.yaml" } }, "authorities": { "description": "__Read-only__ The authoritative service IPs set by Akamai. Any changes you make to `authorities` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "authoritiesDnsNames": { "description": "__Read-only__ NS records for the the authoritative service IPs set by Akamai. Any changes you make to `authoritiesDnsNames` are ignored.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "contractId": { "description": "The contract for this proxy.", "type": "string" }, "createdTime": { "description": "An ISO 8601 timestamp showing when the proxy was created.", "format": "date-time", "type": "string" }, "ecsSetting": { "description": "Whether ECS forwarding is enabled for this proxy.", "type": "boolean" }, "fullIpPassthroughEnabled": { "description": "Whether the full client IP is forwarded in ECS options (`/32` for IPv4, `/128` for IPv6) rather than a truncated prefix. Requires `ecsSetting` to be `true`.", "type": "boolean" }, "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" } }, "id": { "description": "The proxy ID.", "type": "string" }, "lastModifiedTime": { "description": "An ISO 8601 timestamp showing when the proxy was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "The proxy name.", "type": "string" }, "originNameserverZoneTransferTargets": { "deprecated": true, "description": "__Deprecated__ The names or addresses to perform outbound zone transfers for `AUTOMATIC` filter mode. The default value is the `originNameservers` section.", "items": { "type": "string" }, "type": "array", "x-akamai": { "status": "DEPRECATED" } }, "originNameservers": { "description": "The names or addresses of the master name servers to protect.", "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" }, "zoneTransferNameservers": { "description": "The names or addresses to perform outbound zone transfers with `filter_mode` of `AUTOMATIC`. If this field is omitted the `originNameserverZoneTransferTargets` section is used.", "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": [ "name", "contractId", "originNameservers", "healthCheck" ], "type": "object", "x-akamai": { "file-path": "schemas/proxy-post.yaml" } }, "type": "array" } }, "required": [ "items" ], "type": "object", "x-akamai": { "file-path": "schemas/get-proxies-response.yaml" } } } }, "description": "Proxies using a TSIG key." }, "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 access this proxy zone." }, "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 zone or TSIG key doesn't exist or isn't accessible." } }, "summary": "List proxies for a TSIG key", "tags": [ "Proxy zones" ] }, "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": "The proxy zone name.", "in": "path", "name": "name", "required": true, "schema": { "example": "example.com", "type": "string" }, "x-akamai": { "file-path": "parameters/proxy-zone-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/proxy-used-by.yaml", "path-info": "/proxies/{proxyId}/zones/{name}/key/used-by" } } }, "servers": [ { "url": "https://{hostname}/config-dns/v2" } ], "tags": [ { "description": "Groups operations to manage proxy zones.", "name": "Proxy zones" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "06-dns-shield.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ``` # Sibling pages * [List proxy zones](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones.md) * [List proxy zone keys](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zone-keys.md) * [Get a proxy zone by name](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-name.md) * [Save the apex alias for a proxy zone](https://techdocs.akamai.com/edge-dns/reference/put-proxy-zone-apex-alias.md) * [Delete apex alias for a proxy zone](https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zone-apex-alias.md) * [Get a proxy zone TSIG key by name](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zones-name-key.md) * [Update a proxy zone TSIG key by name](https://techdocs.akamai.com/edge-dns/reference/put-proxy-zones-name-key.md) * [Delete a proxy zone TSIG key by name](https://techdocs.akamai.com/edge-dns/reference/delete-proxy-zones-name-key.md) * [Get a manual filter report](https://techdocs.akamai.com/edge-dns/reference/get-proxy-zone-manual-filter-report.md) * [Manage manual filter names](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names.md) * [Initialize manual filter names with a zone file](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-manual-filter-names-file.md) * [Purge Zone records from Shield NS53's cache](https://techdocs.akamai.com/edge-dns/reference/post-proxy-zone-clear-cache.md) * [Schedule an immediate proxy zone's transfer](https://techdocs.akamai.com/edge-dns/reference/put-proxy-zone-schedule-immediate-transfer.md)