List TSIG keys

get https://{hostname}/config-dns/v2/keys

Get the TSIG keys used by zones that you're allowed to manage.

Response

Response body

object

keys

array of objects

required

This block contains keys that matched the request.

keys*

object

algorithm

string

required

The algorithm used to encode the TSIG key's secret data. Possible values are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512, or HMAC-MD5.SIG-ALG.REG.INT.

hmac-md5 hmac-sha1 hmac-sha224 hmac-sha256 hmac-sha384 hmac-sha512 HMAC-MD5.SIG-ALG.REG.INT

name

string

required

The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.

secret

string

required

A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input isn't correctly padded, the server applies the padding.

zonesCount

integer

≥ 1

The number of zones that reference this key.

metadata

object

required

This block contains information about the request, including any parameters, and the response, including its size.

contracts

array of strings

If the contractIds parameter was passed in, this field contains the contract IDs.

contracts

gid

integer

If the gid parameter was passed in, this field displays its value.

string

If the search parameter was passed in, this field displays its value.

sortBy

array of strings

If the sortBy parameter was passed in, this field contains the sorting fields.

sortBy

totalElements

integer

required

≥ 0

The total number of TSIG keys that matched the request parameters.

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/keys \
3
     --header 'accept: application/json'


xxxxxxxxxx
19
 
1
{
2
  "keys": [
3
    {
4
      "algorithm": "hmac-sha256",
5
      "name": "a.example.key.",
6
      "secret": "DjY16JfIi3JnSDosQWE7Xkx60MbCLo1K7hUCqng8ccg=",
7
      "zonesCount": 3
8
    },
9
    {
10
      "algorithm": "hmac-sha512",
11
      "name": "another.example.key.",
12
      "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw==",
13
      "zonesCount": 7
14
    }
15
  ],
16
  "metadata": {
17
    "totalElements": 2
18
  }
19
}

200Successful operation.