PUT - Update a specific DS record

Purpose

This API call modifies a DS record within a specified DNS zone. DS records ensure the integrity and authenticity of DNS responses in a DNSSEC-enabled setup by providing the cryptographic data required for secure delegation from a parent zone to a child zone.

Request URL

Method: PUT

https://{appconsole_IP}:{9443}/api/dns/zone/{zone_pk}/DS/{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

  • zone_pk* long
    • The unique identifier of the DNS zone where the DS record exists.
  • pk* long
    • The unique identifier of the DS record to be updated.

Request Body

  • domain_name* string
    • The fully qualified domain name (FQDN) for which the DS record is being updated.
  • domain_ttl* integer
    • Time-to-Live value for the record, indicating how long the record should be cached by resolvers.
  • zone_name* string
    • The DNS zone where the DS record resides.
  • cluster_name* string
    • The cluster under which the zone is managed.
  • records* an array of string

      A list of DS record objects containing cryptographic data for DNSSEC validation.

    • -keyTag: Identifier for the DNSSEC key, used to match the DS record with its corresponding DNSKEY record
    • -algorithm: Algorithm number used by the DNSSEC key.
    • -digestType: Digest algorithm type used to create the cryptographic hash.
    • -digest: Cryptographic hash of the DNSKEY record, ensuring the chain of trust between parent and child zones.

 

* - Mandatory parameter.

 

Sample Request

Copied
{
  "domain_name": "ds35.hellotest109.com.",
  "domain_ttl": 8640,
  "zone_name": "hellotest109.com.",
  "cluster_name": "newcluster7",
  "records": [
    {
      "keyTag": 7,
      "algorithm": 5,
      "digestType": 4,
      "digest": "81427470f1c5765d537e2a54b3782b0c519dcf19cd1156a2b67f668fd3f4e94ad36e737b3992ebec64a695fc2d1a670f"
    }
  ],
  
}

Sample Response

Copied
{
  "zone_id": 5867,
  "domain_name": "ds35.hellotest109.com.",
  "domain_ttl": 8640,
  "ds_domain_id": 152,
  "zone_name": "hellotest109.com.",
  "cluster_name": "wincluster-zoho",
  "records": [
    {
      "keyTag": 7,
      "algorithm": 5,
      "digestType": 4,
      "digest": "81427470f1c5765d537e2a54b3782b0c519dcf19cd1156a2b67f668fd3f4e94ad36e737b3992ebec64a695fc2d1a670f"
    }
  ]
}