GET - GET a specific CNAME Record by ID

Purpose

This API retrieves a specific CNAME (Canonical Name) record under a DNS zone. CNAME records are used to map one domain name (alias) to another domain name (canonical name). This API provides real-time retrieval of CNAME records, ensuring efficient domain aliasing and redirection for network administrators.

Request URL

Method: GET

https://{appconsole_IP}:{9443}/api/dhcp/zone/{zone_pk}/CNAME/{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 CNAME record exists.
    • Example: 5867.
  • pk* long
    • The unique identifier of the specific CNAME record to retrieve.
    • Example: 10805.

 

* - Mandatory parameter.

 

Sample Response

Copied
{
   "domain_name":"c28.hellotest109.com.",
   "domain_ttl":86400,
   "cname_domain_id":12106,
   "zone_id":5867,
   "records":[
      "c42.host.com"
   ]
}