Logo
Akamai APIs API Documentation

TSIG keys

Number of APIs: 8


1. List TSIG keys

GET https://{{host}}/config-dns/v2/keys

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



2. Update a TSIG key across zones

POST https://{{host}}/config-dns/v2/keys/bulk-update

This updates the key data for multiple zones at once. Keep in mind that this operation can only add zones to a TSIG key, not remove them. To safely remove the association between a zone and a TSIG key, update the zone to its new TSIG key or remove the key from the zone if you're sure it's no longer needed.



3. List zones using TSIG key

POST https://{{host}}/config-dns/v2/keys/used-by

Returns a list of zone names that use the given TSIG key and for which the current user has READ access. If the list of zones returned is empty, it's possible that the given key is in use by other zones but the current user doesn't have permission to view those zones.



4. List of zones to contract using TSIG key

POST https://{{host}}/config-dns/v2/keys/used-by/zone-contract-map

List of zone names within a contract that use the given TSIG key for which the current user has READ access. If the list returned is empty, it's possible that the given key is in use by other zones but the current user doesn't have permission to view those zones.



5. Get a zone's TSIG key

GET https://{{host}}/config-dns/v2/zones/:zone/key

Retrieves the TSIG Key data for this zone. Includes a count of zones that use this key. Returns a 404 error if the zone doesn't have a TSIG key.



6. Update a zone's TSIG key

PUT https://{{host}}/config-dns/v2/zones/:zone/key

Creates or replaces the current TSIG Key for this zone. If other zones use the same key, doesn't modify those zones.



7. Delete a zone's TSIG key

DELETE https://{{host}}/config-dns/v2/zones/:zone/key

Removes the TSIG Key for this zone. This action doesn't affect any other zone, even if they share the same TSIG key as this zone. If the zone doesn't currently have a key, no actions are taken and no error is thrown.



8. List users of a zone's TSIG key

GET https://{{host}}/config-dns/v2/zones/:zone/key/used-by

Lists the Zones that use the same TSIG key as this zone.



ENDPOINTS