PUT - Update a specific TSIG Key

Purpose

This API allows administrators to modify the configuration of a TSIG key in a specified cluster. TSIG keys ensure secure and authenticated DNS operations, enhancing the security of DNS transactions such as zone transfers and dynamic updates by authenticating communication between DNS servers and between DNS and DHCP servers.

Request URL

Method: PUT

https://{appconsole_IP}:{9443}/api/dns/tsig_pk/{pk}/

Request Headers

The following headers must be included in the API request for successful authentication and data submission:

Authorization: DDI Central's OAuth implementation uses the Bearer authentication scheme. Hence, while making API calls, access_token obtained via the OAuth 2.0 Client Credentials Grant must be included in the Authorization header of API requests. This token verifies the client’s identity and ensures appropriate permissions for accessing resources.

The Authorization Header follows the format below:

headers = { "Authorization": "Bearer {bearer_tk}" }


Content-Type: Required in the header to indicate the media type of the resource being sent. It helps the server at the receiving end understand how to process the transmitted request body.

The Content-Type Header follows the format below:

headers ={ "Content-Type": "application/json" }

Path Parameters

  • tsig_pk* long
    • The unique identifier of the TSIG key to be updated.

Request Body

  • key_name* string
    • The name of the TSIG key to be updated.
  • cluster_name* string
    • The name of the cluster where the TSIG key is managed.
  • algorithm* string

    • The cryptographic algorithm used for the TSIG key. The following algorithms are available:

      HMAC-MD5

      HMAC-SHA1

      HMAC-SHA224

      HMAC-SHA256

      HMAC-SHA384

      HMAC-SHA512

      These algorithms ensure secure and authenticated DNS operations by encrypting and validating communications between servers.

  • secret_key* string
    • The base64-encoded secret key used for authentication.

 

* - Mandatory parameter.

 

Sample Request

Copied
{
  "cluster_name": "chennai2",
  "key_name": "tsig134",
  "algorithm": "HMAC-MD5",
  "secret_key": "yCPav0xvvdJQbQuFF8LyBk=="
}

Sample Response

Copied
{
  "message": "Updated successfully."
}