GET - Get all TSIG Keys in a cluster

Purpose

This API call retrieves all TSIG (Transaction Signature) keys configured within a specific cluster. TSIG keys enhance security by authenticating DNS transactions, such as zone transfers (AXFR/IXFR) between DNS servers and dynamic updates from DHCP servers when they update IP addresses for DDNS (Dynamic DNS) zones, ensuring integrity and protection against unauthorized modifications.

Request URL

Method: GET

https://{appconsole_IP}:{port_number}/api/dns/tsig/?cluster_name={cluster_name}
https://10.16.5.16:9443/api/dns/tsig/?cluster_name={cluster_name}

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" }

Query parameters

  • cluster_name*  string

    •  The name of the cluster for which the TSIG keys are to be retrieved (e.g., "chennai").

 

* - Mandatory parameter.

 

Sample Response

Copied
Copied
[
  {
    "tsig_id": 9,
    "key_name": "tsig13",
    "algorithm": "HMAC-MD5",
    "secret_key": "yCPav0xvvdJQbQuFF8LyBk==",
    "category": "zone_axfr",
    "zone_list": [
      "rpz29.zoho.com.",
      "rpz28.zoho.com.",
      "rpz291.zoho.com.",
      "rpz26.zoho.com.",
      "rpz27.zoho.com.",
      "rpz24.zoho.com.",
      "rpz23.zoho.com.",
      "marshal129.zoho.com."
    ]
  },
  {
    "tsig_id": 10,
    "key_name": "tsig14",
    "algorithm": "HMAC-MD5",
    "secret_key": "M3uxA9HwUFyGEmar20ifWg==",
    "category": "zone_axfr",
    "zone_list": [
      "marshal3.joho.com."
    ]
  },
  {
    "tsig_id": 11,
    "key_name": "tsig134",
    "algorithm": "HMAC-MD5",
    "secret_key": "yCPav0xvvdJQbQuFF8LxBw==",
    "category": "zone_axfr",
    "zone_list": [
      
    ]
  }
]

Show full

Show less