Domains
Covered in this doc:

Search available domains

This method allows you search against registered domains using a keyword and see if they are available or already registered.
1
GET /api/v2/domains/search/?keyword=somebusinessname
Copied!

Parameters

Name
Type
Description
keyword
string
required This is the search query. It can accept a set of keywords (i.e. "some business name") or the actual domain desired (i.e. "somebusinessname.com")

Response

1
[
2
{
3
"available": false,
4
"domain": "somebusinessname.com"
5
},
6
{
7
"available": false,
8
"domain": "somebusinessname.net"
9
},
10
{
11
"available": true,
12
"domain": "somebusinessname.org"
13
}
14
]
Copied!

List domains

List all domains currently registered
1
GET /api/v2/domains/
Copied!

Response

1
{
2
"meta": {
3
"limit": 20,
4
"next": "/api/v2/businesses/?limit=20&offset=20",
5
"offset": 0,
6
"previous": null,
7
"total_count": 1039
8
},
9
"objects": [
10
{
11
"auto_renew": false,
12
"expires": "2016-06-26",
13
"id": 1401,
14
"registered": "2013-06-26",
15
"registrar": "namecom",
16
"resource_uri": "/api/v2/domains/1401/",
17
"sld": "somebusinessname",
18
"tld": "com",
19
"user_id": 248114,
20
"whois_privacy": false,
21
"whois_privacy_expires": null
22
},
23
...
24
]
25
}
Copied!

Register a domain

Register a domain by providing the domain name as well as the registrant contact details (name, address, etc)
1
POST /api/v2/domains/
Copied!

Parameters

Name
Type
Description
first_name
string
required First name of domain owner
last_name
string
required Last name of domain owner
address_1
string
required Street address of domain owner
city
string
required
state
string
required Two character state/provence code
zip
string
required
country
string
required Two character country code (i.e. US, CA)
phone
string
required Contact phone number
email
string
required Contact email address
period
integer
required Number of years to register the domain
Optional
address_2
string
Apt/unit number
organization
string
Name of the business/organization. Optional but required for .org domains
partner_domain_id
string
Unique partner ID for this domain for tracking purposes (billing, account ID). Only one domain can exist for each for these IDs.
partner_domain_sub_id
string
Partner ID that is not unique for tracking purposes.

Response

A status code of 201 created is returned on a successful creation and contains the created domain object as JSON

Registrant details

For an individual domain, you can retrieve the registrant details like name, address and contact information on the domain.
1
GET /api/v2/domains/:id/detail/
Copied!

Response

1
{
2
"auto_renew":false,
3
"contacts":[
4
{
5
"address_1":"555 Main St",
6
"address_2":"",
7
"city":"Seattle",
8
"country":"US",
9
"email":"[email protected]",
10
"fax":"",
11
"first_name":"John",
12
"last_name":"Doe",
13
"organization":"",
14
"phone":"+12065555555",
15
"state":"WA",
16
"tax_id":"",
17
"type":[
18
"registrant",
19
"administrative",
20
"billing",
21
"technical"
22
],
23
"zip":"98121"
24
}
25
],
26
"create_date":"2019-01-29T23:27:58",
27
"domain_name":"domainname.com",
28
"expire_date":"2020-01-29T23:27:58",
29
"locked":true,
30
"nameservers":[
31
"ns1mtw.name.com",
32
"ns2bkr.name.com",
33
"ns3cqz.name.com",
34
"ns4fmw.name.com"
35
]
36
}
Copied!

Renew a Domain

Renew a domain for a period of years.
1
POST /api/v2/domains/:id/renew/
Copied!

Parameters

Name
Type
Description
period
integer
required Number of additional years to renew the domain

Response

A status code of 202 accepted is returned on a successful renewal of the domain and contains the domain object as JSON

Reset DNS zone for domain

This method will reset the DNS entries assigned to a domain to defaults for the instance. This is helpful if you have changed values and would like to update an older domain's DNS records.
1
PUT /api/v2/domains/:id/reset_zone/
Copied!
Last modified 1yr ago