API Documentation

Everything you must know in one place

IMPORTANT:  We recommend you use HTTPPOST method when setting more than 10 hostnames.

All host records that are not included into the API call will be deleted, so add them in addition to new host records.


Sets DNS host records settings for the requested domain.

NOTE: The [ ] brackets are used to represent optional values (e.g.[1...n]). Do not include the [ ] brackets in your API requests.

Example Request


Request Parameters

Global parameters are not shown here for clarity, but should be present in all requests

Name Type MaxLength Required? Description
SLD String 70 Yes SLD of the domain to setHosts
TLD String 10 Yes TLD of the domain to setHosts
HostName[1..n] String No Yes Sub-domain/hostname to create the record for
RecordType[1..n] String No Yes Possible values A, AAAA, CNAME, MX, MXE, TXT, URL,URL301, FRAME
Address[1..n] String No Yes Possible values are URL or IP address. The value for this parameter is based on RecordType.
MXPref[1..n] String No Yes MX preference for host. Applicable for MX records only.
EmailType String No No Possible values are MXE, MX, FWD, OX
TTL[1..n] String No No

Time to live for all record types.Possible values: any value between 60 to 60000
Default Value: 1800

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  <Errors />
  <CommandResponse Type="namecheap.domains.dns.setHosts">
    <DomainDNSSetHostsResult Domain="domain51.com" IsSuccess="true" />

Response Parameters

Name Description
Domain The domain name for which you are trying to set host records.
IsSuccess Indicates whether host records were set successfully.

Error Codes

Specifies the error codes that might be returned from this method

Number Description
2019166 Domain not found
2016166 Domain is not associated with your account
2030166 Edit permission for domain is not supported
3013288, 4013288 Too many records
3031510 Error From Enom when Errorcount <> 0
3050900 Unknown error from Enom
4022288 Unable to get nameserver list


We welcome your comments, questions, corrections and additional information relating to this article. Your comments may take some time to appear. Please be aware that off-topic comments will be deleted.

If you need specific help with your account, feel free to contact our Support Team. Thank you.

Need help? We're always here for you.

× Close