POST - Create a CNAME record in a zone

Purpose

This API call is designed to create a Canonical Name (CNAME) record in a zone within a Windows DNS cluster environment.

Request URL 

Method: POST

https://{appconsole_IP}:{9443}/api/dns/zone/{zone_pk}/CNAME/

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.

Request Body

  • domain_name*  string
    •  Specifies the full domain name for which DNS records are being set up.
  • domain_ttl*  int
    •  Defines the Time to Live (TTL) value of the domain name that should be cached by DNS resolvers.
  • zone_name*  string
    •  Represents the main domain or DNS zone this record belongs to.
  • records*  an array of string
    • The canonical domain name to which the alias points (e.g., ["c1.host.com"]).
    • A CNAME record can only point to one canonical (target) domain. It cannot have multiple targets directly. To represent multiple aliases pointing to different canonical domains, you must create separate CNAME records for each alias..
  • cluster_name*  string
    •  Denotes a specific server cluster where the domain should resolve.

 

* - Mandatory parameter.

 

 

Sample Request

Copied
Copied{
   "domain_name":"c27.hellotest109.com.",
   "domain_ttl":9640,
   "zone_name":"hellotest109.com.",
   "records":[
      "c1.host.com"
   ],
   "cluster_name":"wincluster-zoho"
}

Sample Response

Copied
Copied{
   "cname_domain_id":12105,
   "zone_id":5867,
   "domain_name":"c27.hellotest109.com.",
   "domain_ttl":9640,
   "records":[
      "c1.host.com"
   ]
}