List proxies for a TSIG key

get https://{hostname}/config-dns/v2/proxies/{proxyId}/zones/{name}/key/used-by

List proxies that use a TSIG key.

Response

Response body

object

items

array of objects

required

Proxies response.

items*

object

activationState

string

Read-only The current proxy activation status. Either NEW, PENDING, ACTIVE, LOCKED, DELETED, or ERROR.

NEW PENDING ACTIVE LOCKED DELETED ERROR

authorities

array of strings

Read-only The authoritative service IPs set by Akamai. Any changes you make to authorities are ignored.

authorities

authoritiesDnsNames

array of strings

Read-only NS records for the the authoritative service IPs set by Akamai. Any changes you make to authoritiesDnsNames are ignored.

authoritiesDnsNames

contractId

string

required

The contract for this proxy.

createdTime

date-time

An ISO 8601 timestamp showing when the proxy was created.

healthCheck

object

required

The names or addresses of the master name servers to protect.

string

The proxy ID.

lastModifiedTime

date-time

An ISO 8601 timestamp showing when the proxy was last modified.

name

string

required

The proxy name.

originNameserverZoneTransferTargets

array of strings

deprecated

Deprecated The names or addresses to perform outbound zone transfers for AUTOMATIC filter mode. The default value is the originNameservers section.

originNameserverZoneTransferTargets

originNameservers

array of objects

required

The names or addresses of the master name servers to protect.

originNameservers*

object

name

string

Master name server name or address.

port

integer

Defaults to 53

The master name server port number.

zoneTransferNameservers

array of objects

The names or addresses to perform outbound zone transfers with filter_mode of AUTOMATIC. If this field is omitted the originNameserverZoneTransferTargets section is used.

zoneTransferNameservers

object

name

string

Master name server name or address.

port

integer

Defaults to 53

The master name server port number.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/config-dns/v2/proxies/proxyId/zones/name/key/used-by \
3
     --header 'accept: application/json'


xxxxxxxxxx
65
}
1
{
2
  "items": [
3
    {
4
      "activationState": "ACTIVE",
5
      "authorities": [
6
        "192.0.2.161",
7
        "2001:db8:6b4e:3234:365e:6afe:54d6:9b32"
8
      ],
9
      "authoritiesDnsNames": [
10
        "c1-25.akashield.net",
11
        "c2-30.akashield.net"
12
      ],
13
      "contractId": "C-0N7RAC7",
14
      "createdTime": "2024-12-20T00:00:00Z",
15
      "healthCheck": {
16
        "recordName": "example.com",
17
        "recordType": "SOA"
18
      },
19
      "id": "dc33c6bf-801c-577d-b6f7-d9a058eaa7db",
20
      "lastModifiedTime": "2024-12-24T00:00:00Z",
21
      "name": "Rivers Shields",
22
      "originNameserverZoneTransferTargets": [
23
        "192.0.2.167",
24
        "192.0.2.254"
25
      ],

200Proxies using a TSIG key.