reseller

is added when reseller has a customer specific business

Resending the Transfer Approval Mail

Description

Resends the Transfer Approval Mail for the specified Order.

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 for which the RFA mail needs to be resent.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/resend-rfa.json?auth-userid=0&api-key=key&order-id=0

Response

Returns true (String) if mail is sent successfully.

Modifying TEL Whois Preference

Description

Modifies the Whois Preference of the .TEL Domain Registration Order.

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 of the Domain Registration Order for which you need to modify the Whois Preference.
whois-type String Required It can be either Natural or Legal
publish String Optional Whether Whois details are to be published or not: Y/N.

This parameter is required if whois-type parameter is Natural, otherwise is it Optional.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/tel/modify-whois-pref.json?auth-userid=0&api-key=key&order-id=0&whois-type=Legal&publish=y

Response

Returns a hash map containing the Whois modification request status details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Whois Preference Modification Action (actiontypedesc)

  • Action ID of the Whois Preference Modification Action (eaqid)

  • Whois Preference Modification Action Status (actionstatus)

  • Description of the Whois Preference Modification Action Status (actionstatusdesc)

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

Search

Description

Gets a list of Domain Registration Orders matching the search criteria, along with the details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched. This should be a value between 10 to 500.
page-no Integer Required Page number for which details are to be fetched
order-by Array of Strings Optional

One or more parameters by which you want to sort the Orders. Values can be orderid, customerid, endtime, timestamp, entitytypeid, creationtime or creationdt.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. If page-no is 2, no-of-records
is 30 and order-by is order id; it will fetch the second batch of 30 Orders sorted by orderid.
order-id Array of Integers Optional Order Id(s) of the Domain Registration Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller Id(s) whose Orders need to be fetched
customer-id Array of Integers Optional Customer Id(s) whose Orders need to be fetched
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not
product-key Array of Strings Optional Product keys of the TLDs
status Array of Strings Optional

Status of the Order, namely, InActive, Active, Suspended, Pending Delete Restorable, Deleted, Archived, Pending Verification or Failed Verification

  • Deleted - to be used for searching Orders deleted in the past 30 days

  • Archived - to be used for searching Orders deleted more than 30 days ago

  • Pending Verification - to be used for searching Orders for which the Registrant Contact email address verification is pending

  • Failed Verification - to be used for searching Orders which have been deactivated due to non-verification of the Registrant Contact email address

Additional Information

Whois Data Verification
domain-name String Optional Name of the Domain
privacy-enabled String Optional

Privacy Protection status of the Order, namely, true, false or na

  • true - to be used for searching Orders for which Privacy Protection is enabled

  • false - to be used for searching Orders for which Privacy Protection is disabled

  • na - to be used for searching Orders for which Privacy Protection is not applicable (not allowed). The search results will include Inactive Orders as well.
creation-date-start String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Expiry Date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Expiry Date is less than expiry-date-end

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/search.json?auth-userid=0&api-key=key&no-of-records=10&page-no=1

Response

Returns a hash map containing the below details of the Domain Registration Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Addition Timestamp (orders.creationdt)

  • Order Creation (at the Registry) Timestamp (orders.creationtime)

  • Timestamp for the Last Modification Action on the Order (orders.timestamp)

  • Expiry (at the Registry) Timestamp (orders.endtime)

  • Current Order Status under the System (entity.currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted, Archived, Pending Verification or Failed Verification

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

  • Reseller Lock Status (orders.resellerlock)

  • Customer Lock Status (orders.customerlock)

  • Transfer Lock Status (orders.transferlock)

  • Privacy Protection Status (orders.privacyprotection)

Getting Details of the Domain Registration Order using Order Id

Description

Gets details of the Domain Registration Order associated with the specified Order Id.

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 of the Domain Registration Order whose details need to be fetched.
options Array of Strings Required Values can be: All, OrderDetails, ContactIds, RegistrantContactDetails, AdminContactDetails, TechContactDetails,
BillingContactDetails, NsDetails, DomainStatus, DNSSECDetails, StatusDetails.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/details.json?auth-userid=0&api-key=key&order-id=0&options=OrderDetails

Response

Returns a hash map containing details of the Domain Registration Order as below:

  • Order ID (orderid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Lock/Hold on the domain name at the Registry (orderstatus) - value(s) will be resellersuspend, resellerlock and/or transferlock

  • Lock/Hold on the domain name in the System (domainstatus) - value(s) will be sixtydaylock and/or renewhold

  • Product Category (productcategory)

  • Product Key (productkey)

  • Order Creation (at the Registry) Date (creationtime)

  • Registrant Contact Email Address Verification Status (raaVerificationStatus) - value will be Verified, Pending or Suspended

  • Start Time of the Registrant Contact Email Address Verification Process (raaVerificationStartTime) - will not be displayed if the Verification Status is Verified

  • Expiry Date (at the Registry) (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Number of Name Servers associated with the Domain Name (noOfNameServers)

  • Name Servers (ns1 and ns2)

  • Child Name Servers (cns)

  • Domain Secret (domsecret)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Privacy Protection allowed for the Product Type (privacyprotectedallowed)

  • Whether Order is Privacy Protected (isprivacyprotected)

  • Privay Protection Details:

    • Privacy Protection Expiry Date (privacyprotectendtime)

    • Privacy Protect Registrant Contact Details (privacy-registrantcontact)

    • Privacy Protect Admin Contact Details (privacy-admincontact)

    • Privacy Protect Technical Contact Details (privacy-techcontact)

    • Privacy Protect Billing Contact Details (privacy-billingcontact)

  • Whether Order Deletion is Allowed (allowdeletion)

  • Registrant Contact ID (registrantcontactid)

  • Registrant Contact Details (registrantcontact)

  • Admin Contact ID (admincontactid)

  • Admin Contact Details (admincontact)

  • Technical Contact ID (techcontactid)

  • Technical Contact Details (techcontact)

  • Billing Contact ID (billingcontactid)

  • Billing Contact Details (billingcontact)

  • Delegation Signer (DS) Record Details (dnssec):

    • Key Tag (keytag)

    • Algorithm (algorithm)

    • Digest Type (digesttype)

    • Digest (digest)

Details differ based on the value passed for the options parameter:

Options Details Returned
All All values listed above
OrderDetails domainname, entityid, orderstatus, creationtime, endtime, productcategory, productkey, isImmediateReseller, parentkey, customerid, domsecret, isOrderSuspendedUponExpiry, orderSuspendedByParent, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact, privacy-billingcontact and allowdeletion
ContactIds isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact, privacy-billingcontact, registrantcontactid, admincontactid, techcontactid and billingcontactid
RegistrantContactDetails / AdminContactDetails / TechContactDetails / BillingContactDetails isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact / privacy-admincontact / privacy-techcontact / privacy-billingcontact and registrantcontactid / admincontactid / techcontactid / billingcontactid
NsDetails noOfNameServers, ns1, ns2, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact
DomainStatus domainstatus, raaVerificationStatus, raaVerificationStartTime, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact
DNSSECDetails dnssec, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact
StatusDetails entityid, currentstatus, isImmediateReseller, isOrderSuspendedUponExpiry, isprivacyprotected, description, privacyprotectedallowed
Note

  • privacyprotectedallowed will be returned only if Privacy Protection feature is supported for the Product Type (TLD).

  • privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact will be returned only if Privacy Protection is enabled for the domain name.

Check Availability

Description

Checks the availability of the specified domain name(s).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name Array of Strings Required Domain name(s) that you need to check the availability for
tlds Array of Strings Required TLDs for which the domain name availability needs to be checked See details
suggest-alternative Boolean Optional Pass true if domain name suggestions are required. Default value is false.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

Response

Returns a hash map containing domain name availability status for the requested TLDs:

  • Domain Availability Status (status)

    • available - domain name available for registration

    • regthroughus - domain name currently registered through the Registrar whose connection is being used to check the availability of the domain name

    • regthroughothers - domain name currently registered through a Registrar other than the one whose connection is being used to check the availability of the domain name. If you wish to manage such a domain name through your Reseller / Registrar Account, you may pass a Domain Transfer API call. See details

    • unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the domain name availability after some time.

      Note

      • In case of Donuts TLDs, domain name availability can be checked for a maximum of 5 domain names per Donuts TLD group in one API call. Including more than 5 domain names belonging to the same Donuts TLD group in an API call will return the status as unknown for all the domain names.

        Additional Information

        Donuts TLDs

      • In case of .CA TLD, domain name availability can be checked for a maximum of 15 strings in one API call. Including more than 15 strings in an API call will return the status as unknown for all the strings.

  • Trademark Claims Key (tm-claims-key) - will be returned only if the domain name is available and Trademark for that domain name is listed in the Trademark Clearinghouse database

  • Premium Names (costHash) - A hash map will be returned only if the
    domain is a premium name along with the pricing of the domain ("create",
    "renew", "transfer") and the selling currency symbol

  • Early Access Program (costHash) - A hash map will be returned only
    if the domain is in EAP along with the early access fee
    ("early_access_fee") and the selling currency symbol. The early access fee
    is the non-refundable component which needs to added to the selling price
    of the domain

    • Additional Information

    Trademark Claim Process

  • 3rd Level .UK domain name (ror) - will be returned for an available 2nd Level .UK domain name, if the corresponding 3rd Level .UK domain name already exists. Currently, a 2nd Level .UK domain name can only be registered by the person/entity that owns the 3rd Level .UK domain name, if it already exists.

    Note

    For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.

Getting Order Id

Description

Gets the Order Id of a Registered domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The Registered domain name whose Order Id you want to know.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/orderid.json?auth-userid=0&api-key=key&domain-name=domain.com

Response

Returns the Order Id (Integer) associated with a registered domain name.

Restoring a domain name

Restore

Restores the specified Domain Registration Order.

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 of the Domain Registration Order that you want to restore
invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:

  • NoInvoice: This will not raise any Invoice. The Order will be restored.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be restored.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be restored.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/restore.json?auth-userid=0&api-key=key&order-id=0&invoice-option=KeepInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action ID of the Domain Restoration Action (eaqid)

  • Description of the Domain Restoration Action (actiontypedesc)

  • Domain Restoration Action Status (actionstatus)

  • Description of the Domain Restoration Action Status (actionstatusdesc)

  • Invoice ID of the Domain Restoration Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Price for Customers (sellingamount)

  • Customer ID associated with the Domain Registration Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Cancelling a Transfer

Description

Cancels the Transfer-In Order that is awaiting Admin approval.

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 of the Transfer request that you want to Cancel

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/cancel-transfer.json?auth-userid=0&api-key=key&order-id=0

Response

Returns Success (String) if the transfer request is cancelled.

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

Transfer

Description

Transfers a domain name.

Note

You need to ensure that the domain name is not Locked.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-key String Required Authentication Parameter
domain-name String Required Specify the domain name that you want to transfer.
auth-code String Optional

Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer.

The Authorization Code would be required to transfer a domain name of any of the following TLDs (extensions):

  • .AU

  • .BIZ

  • .BZ

  • .CA

  • .CC

  • .CO

  • .COM

  • .COOP

  • .DE

  • .EU

  • .IN (including only these Third Level .IN Domains: .CO.IN, .NET.IN, .ORG.IN, .GEN.IN, .FIRM.IN, .IND.IN)

  • .INFO

  • .MN

  • .MOBI

  • .NAME

  • .NET

  • .NL

  • .NZ

  • .ORG

  • .TV

  • .US

  • .WS

  • .XXX

You may fetch the auth-code from your customer and provide it while placing the Transfer Order. Alternatively, you may initially place the Transfer Order without the auth-code. The Administrative Contact can provide it at the time of approving the Transfer Authorization email received from .

It is recommended that you adopt the second option since it leaves out the requirement for an auth-code at the time of placing the Transfer Order and the customer would be more willing to submit it at a later stage.

Domain Name Extensions for which the Authorization Code needs to be compulsorily provided at this stage:

  • .AU

  • .CA

  • .DE

  • .EU

  • .NZ
customer-id Integer Required The Customer for whom the Order should be added.
reg-contact-id Integer Required

The Registrant Contact of the domain name.

The Identity of the Registrant Contact of a .UK domain name must not be changed during the Transfer process. You may modify the Identity once the domain name has been transferred to , by referring to the process listed at http://www.nominet.org.uk/registrants/maintain/transfer/chargeable/.
admin-contact-id Integer Required

The Administrative Contact of the domain name.

.EU, .NZ, .RU and .UK domain names do not have an Administrative Contact associated with them. You need to pass the value of admin-contact-id as -1 for these domain names.
tech-contact-id Integer Required

The Technical Contact of the domain name.

The Technical Contact associated with a .EU domain name cannot be modified while .NZ, .RU and .UK domain names do not have a Technical Contact associated with them. You need to pass the value of tech-contact-id as -1 for these domain names.
billing-contact-id Integer Required

The Billing Contact of the domain name.

The Billing Contact associated with a .EU domain name cannot be modified while .AT, .BERLIN, .CA, .NL, .NZ, .RU and .UK domain names do not have a Billing Contact associated with them. You need to pass the value of billing-contact-id as -1 for these domain names.
invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:

  • NoInvoice: This will not raise any Invoice. The Order will be executed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the domain name will be transfered.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be executed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The transfer action request will remain pending.
purchase-privacy Boolean optional

Adds the Privacy Protection service for the domain name.

Privacy Protection is not supported for the following TLDs (extensions):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US
protect-privacy Boolean Optional

Enables / Disables the Privacy Protection setting for the domain name.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the domain name.

Note

Auto-Renewal
ns Array of Strings Optional List of Name Servers to be associated with the domain name. A maximum of 13 Name Servers can be specified.
attr-name Map[name] Optional Mapping key of the extra details needed to transfer a domain name. Refer the description of attr-value.
attr-value Map[value] Optional

Mapping value of the extra details required to transfer a domain name. This together with attr-name shall contain the extra details.

    To transfer a .ASIA domain name:

    cedcontactid: For a .ASIA domain name, 'Charter Eligibility Declaration Contact ID' is mandatory. This parameter represents the CED
    Contact ID. You may select any one of the Admin, Technical, Billing or Registrant Contacts as a value for this parameter.

    attr-name1=cedcontactid&attr-value1=0

    To transfer a Premium domain name:

    type: For transferring a Premium domain name, you need to pass an additional paramater type. The value for this parameter will be premiumft.

    attr-name1=type&attr-value1=premiumft

HTTP Method

POST

Example Test URL Request

Example Test URL Request for Transferring a Domain Name with Privacy Protection

https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true

Example Test URL Request for Transferring a .ASIA Domain Name

https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.asia&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=cedcontactid&attr-value1=0

Example Test URL Request for Transferring a Registry Premium Domain Name


https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true&attr-name1=premium&attr-value1=true

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Transfer Action (actiontypedesc)

  • Action ID of the Domain Transfer Action (eaqid)

  • Domain Transfer Action Status (actionstatus)

  • Description of the Domain Transfer Action Status (actionstatusdesc)

  • Invoice ID of the Domain Transfer Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

  • Privacy Protection Details (privacydetails)

    • Domain Name (description)

    • Order ID of the Domain Registration Order (entityid)

    • Action Type (actiontype)

    • Description of the Privacy Protection Purchase Action (actiontypedesc)

    • Action ID of the Privacy Protection Purchase Action (eaqid)

    • Privacy Protection Purchase Action Status (actionstatus)

    • Description of the Privacy Protection Purchase Action Status (actionstatusdesc)

    • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

    • Selling Currency of the Reseller (sellingcurrencysymbol)

    • Transaction Amount in the Selling Currency (sellingamount)

    • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

    • Customer ID associated with the Domain Registration Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Request Parameter Data Types

Although all parameters are sent as strings over HTTP, we have specified the types of parameters used in the HTTP API requests to help you identify the values that can be passed.

  • Boolean: Possible values are true or false.

    Example: ?variable=true

  • Integer: Possible values are positive whole numbers.

    Example: ?variable=1234

  • Float: Possible values are positive numbers with a decimal component.

    Example: ?variable=12.34

  • String: Possible values are context-dependent sequence of characters.

    Example: ?variable=abc123.com

  • Array: Possible values are any context-dependent collection of values of the same type. Arrays are specified by assigning different values of the same type to the same parameter name multiple times. The order in which values are assigned does not matter.

    Example: ?variable=1&variable=2&variable=3&variable=4

  • Map: Possible values are any collection of name-value pairs where name is of type string and value can be any context-dependent type. Name-value pairs are associated with each other by adding the same numeric suffix to them. The numeric suffix, starts from 1 and is incremented for each subsequent name-value pair.

    Example: ?domain-name1=abc.com&nameserver1=abc.example.com&domain-name2=xyz.com&nameserver2=xyz.example.com
    This associates abc.example.com with abc.com and xyz.example.com with xyz.com

Note

  • The parameter values in the API calls are case sensitive and must be passed correctly to fetch complete details in the response.

    For example, the API call to fetch the details of a Domain Registration Order has a paramater options. Values can be: All, OrderDetails, ContactIds, RegistrantContactDetails, AdminContactDetails, TechContactDetails, BillingContactDetails, NsDetails, DomainStatus, DNSSECDetails.

    These values are case sensitive and need to passed in the exact manner as mentioned above.

    https://test.httpapi.com/api/domains/details-by-name.json?auth-userid=0&api-key=key&domain-name=yourdomain.com&options=OrderDetails

  • For associating extra details with a particular Contact or a domain name, the details must be passed in the API call in the form of attr-name and attr-value pairs.
    These name-value pairs must be passed sequentially, such as attr-name1=param&attr-value1=value&attr-name2=param&attr-value2=value. Usage such as attr-name1=param&attr-value1=value&attr-name3=param&attr-value3=value is incorrect.

    Example:

    Correct API call

    https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&[email protected]&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0&type=Contact&attr-name1=title&attr-value1={Title of the Contact in the Company}&attr-name2=website&attr-value2={Company Website}

    Incorrect API call

    https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&[email protected]&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0&type=Contact&attr-name1=title&attr-value1={Title of the Contact in the Company}&attr-name3=website&attr-value3={Company Website}

Subscribe to reseller