GET - GET a specific MX Record by ID

Purpose

This API retrieves a specific MX (Mail Exchanger) record under a DNS zone. MX records define mail servers responsible for handling emails for the domain. This API provides real-time visibility into MX records, ensuring email reliability, redundancy, and optimal delivery performance.

Request URL

Method: GET

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

 

* - Mandatory parameter.

 

Sample Response

Copied
{
   "mx_domain_id":11608,
   "zone_id":5867,
   "domain_name":"mx96.hellotest109.com.",
   "domain_ttl":86400,
   "records":[
      {
         "host_fqdn":"jeswin.mail.com",
         "preference":2
      },
      {
         "host_fqdn":"akash.mail.com",
         "preference":2
      }
   ]
}