Update a zone's TSIG key

put

https://{hostname}/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.

Path Params

zone

string

required

The name of the zone.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

A TSIG key.

algorithm

string

enum

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.

Allowed:

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.

Responses

204

The operation was successful. No response data is returned.

Language

URL

Loading…

Response

Choose an example:

application/problem+json

400Bad Request. The request body contains invalid TSIG key data.

401Unauthorized. Your credentials are missing or invalid.

403Forbidden. You lack write access to this zone's TSIG key or the contracts that use it.

404Not Found. The specified zone doesn't exist or isn't accessible.

409Conflict. The zone is locked for deletion, or a zone-type conflict prevents the update.

415Unsupported Media Type. The request's Content-Type header is not supported. Use application/json.

422Unprocessable Entity. The TSIG key is semantically invalid. For example, the key name is not a valid DNS name, a required field is missing, the secret isn't valid Base64, or the algorithm isn't supported.