GET - Export a Zone

Purpose

This API call is used to export the BIND configuration of a specified zone under a specific cluster. The response includes the BIND-compatible zone file with DNS records such as SOA (Start of Authority), NS (Name Server), A records, and other record types for the zone.

Request URL

Method: GET

https://{appconsole_IP}:{port_number}/api/dns/export_bind/?cluster_name={cluster_name}&zone_name={zone_name}
Example:https://10.16.5.16:9443/api/dns/export_bind/?cluster_name=chennai2&zone_name=exeapi13.com.

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 where the zone resides (e.g., "local-cluster").
  • zone_name* string
    • The name of the zone for which the BIND configuration file needs to be exported (e.g., "exeapi13.com.").

 

* - Mandatory parameter.

 

Sample Response

Copied;SOA

$ORIGIN fwd1.com.

@   86400   IN     SOA     jeswin.gmail.com.   jeswin.gmail.com.   (
                    2024090978 ;serial
                    3600 ;refresh
                    3600 ;retry
                    3600 ;expiry
                    1800 ;minimum

                    )

;Root Records
;NS Records
@  86400   IN  NS jeswin.gmail.com.



;A Records
@  90000   IN  A  1.1.1.1
@  90000   IN  A  2.2.2.2
@  90000   IN  A  10.10.10.10
@  90000   IN  A  3.3.3.5
@  90000   IN  A  5.5.5.5




;Other Records
;A Records
a.fwd1.com.  180   IN  A  1.1.1.1
b.fwd1.com.  180   IN  A  1.1.1.1
c.fwd1.com.  180   IN  A  1.1.1.1

Show full

Show less