Add a Delegation Signer (DS) Record Using the API

When you want to add a Delegation Signer (DS) record for a domain using the API. This article explains supported domain extensions, DS record parameters, DNSSEC requirements, and API request details for DS record creation.

Adding a Delegation Signer (DS) Record

Description

Adds a Delegation Signer (DS) Record for a Domain Registration Order.

Note

Currently, we support DS Record only for the following domain name extensions:

.COM
.IN
.ME
.NET
.ORG

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	Order ID associated with the domain name for which you want to add the DS record
attr-name	Map[name]	Required	Mapping key of the details needed to add a DS Record. Refer the description of attr-value.
attr-value	Map[value]	Required	Mapping value of the details needed to add a DS Record. This together with attr-name shall contain the details. To add a DS Record for a Domain Registration Order: keytag: Contains the tag value of the DNSKEY Resource Record that validates this signature. An integer value in the range 0 to 65536. algorithm: The cryptographic algorithm that is used to generate the signature. An integer value in the range 0 to 255. digesttype: The algorithm type used to construct the Digest. Applicable values are 1, 2 & 3 for .COM / .NET and 1 & 2 for other domain name extensions. digest: An alpha-numeric string generated by applying the Digest Type algorithm to a message. It needs to be a 40-character string for Digest Type value 1 and a 64-character string for Digest Type values 2 and 3.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/domains/add-dnssec.xml?auth-userid=0&api-key=key&order-id=0&attr-name1=keytag&attr-value1=123&attr-name2=algorithm&attr-value2=3&attr-name3=digesttype&attr-value3=1&attr-name4=digest&attr-value4=49FD46E6C4B45C55D4AC49FD46E6C4B45C55D111

Response

Returns a hash map containing the below details:

Domain Name (description)
Order ID of the Domain Registration Order (entityid)
Action Type (actiontype)
Description of the Add DS Record Action (actiontypedesc)
Action ID of the Add DS Record Action (eaqid)
Add DS Record Action Status (actionstatus)
Description of the Add DS Record Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR along with an error message will be returned.

Did you find this article helpful?