POST - Create an HTTPS record in a Zone

Purpose

This API is used to create a new HTTPS DNS record within a specific DNS zone in DDI Central. HTTPS records (defined in RFC 9460) are an advanced DNS type that allows domains to advertise secure service endpoints with metadata such as ALPN (Application-Layer Protocol Negotiation) support, priorities, and target names — improving performance and security for modern web clients.

Request URL

Method: POST

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

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
    • Specifies the unique identifier of the DNS zone where the HTTPS record will be added.
    • Example: 12145.

Request Body

  • domain_name* string
    • The FQDN for the new HTTPS record (e.g., "https63.green.com.") being created under the DNS zone.
  • domain_ttl* integer
    • Time-to-live (TTL) value in seconds, determining how long the record is cached by the resolvers.
    • Example: 5000
  • zone_name* string
    • The DNS zone where the HTTPS record will be added.
    • Example: "green.com".
  • cluster_name* string
    • The cluster name where the DNS zone is hosted (e.g., "chennai2"), used to scope the operation within DDI Central's multi-cluster infrastructure.
  • records*  array
    • An array of HTTPS record objects containing:
      • priority: (integer) Priority for service selection (lower is preferred)
      • targetname: (string) The service target domain
      • parameters: (string) Metadata such as supported ALPN protocols

 

* - Mandatory parameter.

 

Sample Request

Copied
{
    "domain_name": "https56.green.com.",
    "domain_ttl": 5000,
    "zone_name": "green.com.",
    "cluster_name": "chennai2",
    "records": [
        {
        "priority": 4,
        "targetname": "target112.com",
        "parameters": "alpn=\"h2,h3\""
        },
        {
        "priority": 6,
        "targetname": "target222.com",
        "parameters": "alpn=\"h2,h3\""
        }
    ]
    }

Sample Response

Copied
{
    "https_domain_id": 20,
    "zone_id": 12145,
    "domain_name": "https63.green.com.",
    "domain_ttl": 5000,
    "zone_name": "green.com.",
    "cluster_name": "chennai2",
    "records": [
        {
        "priority": 2,
        "targetname": "target51.com.",
        "parameters": "alpn=\"h2,h3,h4\""
        },
        {
        "priority": 3,
        "targetname": "target52.com.",
        "parameters": "alpn=\"h2,h3,h5\""
        }
    ]
}