PUT - Update a specific TXT record

Purpose

This API call updates a specific Text (TXT) record for the given domain in a Windows DNS environment.

Request URL

Method: PUT

https://{appconsole_IP}:{9443}/api/dns/zone/{zone_pk}/SPF_TXT/{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
    • This denotes the unique identifier for the zone.
  • pk* long
    • This denotes the unique identifier for the record.

Request Body

  • domain_name*  string
    •  This parameter specifies the fully qualified domain name (FQDN) for which DNS records are being configured.
  • domain_ttl*  int
    •   Represents the Time to Live (TTL) value, indicating how long (in seconds) the DNS record should be cached by DNS resolvers.
  • zone_name*  string
    •   Refers to the main domain or DNS zone to which this record belongs.
  • cluster_name*  string
    •  Indicates the server cluster where the domain should resolve.
  • records*  an array of string
    •  A list of TXT record values containing descriptive text.
  • record_type*  string
    •  This specifies the type of DNS record.

 

* - Mandatory parameter.

 

 

 

Sample Request

Copied
Copied{
   "domain_name":"txt119.hellotest109.com.",
   "domain_ttl":86400,
   "zone_name":"hellotest109.com.",
   "cluster_name":"wincluster-zoho",
   "records":[
      "Hello 1",
      "Hello 2 "
   ],
   "record_type":"TXT"
}

Sample Response

Copied
Copied{
   "domain_name":"ptr49.hellotest109.com.",
   "domain_ttl":86400,
   "ptr_domain_id":560,
   "zone_id":5867,
   "zone_name":"hellotest109.com.",
   "cluster_name":"wincluster-zoho",
   "records":[
      "ptr1.local.",
      "ptr2.local.",
      "ptr3.local."
   ]
}