GET - GET a specific HTTPS Record by ID

Purpose

This API retrieves the details of a specific HTTPS DNS record from a DNS zone within DDI Central. HTTPS records (as defined in RFC 9460) advertise secure service endpoints, metadata like ALPN protocol support, and DNS-over-HTTPS (DoH) parameters — all through DNS itself. This API is used to fetch the full configuration of a specific HTTPS record and its associated targets.

Request URL

Method: GET

https://{appconsole_IP}:{9443}/api/dhcp/zone/{zone_pk}/HTTPS/{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 primary key of the DNS zone containing the HTTPS record to retrieve.
  • pk*  long
    • The unique identifier of the specific HTTPS record to be fetched.

 

* - Mandatory parameter.

 

Sample Response

Copied
{
    "https_domain_id": 249,
    "zone_id": 15487,
    "domain_name": "look10.api.com.",
    "domain_ttl": 70001,
    "records": [
        {
        "record_id": 415,
        "priority": 45,
        "targetname": "kalki2.com.api.com.",
        "parameters": "alpn=h1,h2,3 dohpath=\"/dns-query{?dns}\"",
        "domain_id": 249
        }
    ]
}