Domains

Detailed representation attributes

domain_name The domain name
expiration_date The expiration date in our system.
will_renew Indicates whether the domain name will renew before reaching the expiration date.

JSON representation

{
    "domain_name": "abc.be",
    "expiration_date": "2016-05-04T08:46:21.75Z",
    "will_renew": false
}

Get domains in your portfolio

The list is paged (paging convention applies).
An empty array is returned if you don't own any domain name.

skip The number of items to skip.
Default: 0
take The number of items to return.
This is limited to 100 domains per request !
Default: 25

Possible errors:

Errorcode HTTP statuscode Description
invalid_paging_request 400 Incorrect paging parameters are passed. Check the 'conventions' documentation for more information.

Example request (default paging)

GET /domains HTTP/1.1
Authorization: hmac 144...07f:Jxo...aiM=:2cb...dd3:1459425654
Accept: application/json, application/xml;q=0.8, */*;q=0.5

Example paged request

GET /domains?skip=100&take=50 HTTP/1.1
Authorization: hmac 144...07f:Jxo...aiM=:2cb...dd3:1459425654
Accept: application/json, application/xml;q=0.8, */*;q=0.5

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Tue, 29 Mar 2016 20:11:05 GMT
X-Ratelimit-Limit: 10
X-Ratelimit-Usage: 4
X-Paging-Skipped: 100
X-Paging-Take: 50
X-Paging-TotalResults: 170
[{ },{ },...,{ }]

Get a specific domain

Returns the details for a specific domain name.

Errorcode HTTP statuscode Description
invalid_request 400 There is no domain name for the request.
domain_not_valid 400 The domain name is not valid.
domain_not_found 404 The domain name does not belong to your portfolio.

Example specific domain request

GET /domains/abc.be HTTP/1.1
Authorization: hmac 144...07f:Jxo...aiM=:2cb...dd3:1459425654
Accept: application/json, application/xml;q=0.8, */*;q=0.5

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Tue, 29 Mar 2016 20:11:05 GMT
X-Ratelimit-Limit: 10
X-Ratelimit-Usage: 4
{ }

Register a domain name

Detailed representation attributes

domain_name The domain name to register

There is no instant feedback due to the nature of the domain registration process.
The application can check the status using the registration status check.

Response content:

Status code 202 (Accepted)
Check-After header The time in seconds after which a check can be made.
This is an indication of the time it usually takes to register a domain name.
Location header The api location to check for registration status.

Possible errors:

Errorcode HTTP statuscode Description
domain_availability_blocked 400 The domain name is blocked for domain availability checks. The domain name cannot be registered using this api.
domain_availability_lookuperror 400 The availability of the domain name cannot be checked for the moment.
domain_availability_taken 400 The domain name is not free. Transfers are currently not supported.
bad_request 400 -
service_unavailable 503 Registration of domain names is currently unavailable.

Example domain registration request

POST /domains/registrations HTTP/1.1
Authorization: hmac 144...07f:Jxo...aiM=:2cb...dd3:1459425654
Accept: application/json, application/xml;q=0.8, */*;q=0.5
{
    "domain_name" : "register.me"
}

Example response

HTTP/1.1 202 ACCEPTED
Content-Type: application/json; charset=utf-8
Date: Tue, 29 Mar 2016 20:11:05 GMT
Check-After: 60
Location: /domains/registrations/COM-20160329-101
X-Ratelimit-Limit: 10
X-Ratelimit-Usage: 4

Check the domain registration result

Using the location header from the domain registration request, you are able to query the status of the domain registration.

Detailed representation attributes

order_code The reference for the domain registration request.
status The status of the registration.

Possible statusses

NotProvisioned The registration hasn't started yet.
Processing The registration is processing.
Pending The registration is currently at the registry or awaiting transfer approval.
Errors The registration wasn't successful.
Finished The registration has finished. The domain name should appear in the list of your domains.
FailedValidation The registration failed validation. The registration is blocked.
Cancelled The registration has been cancelled.

Possible errors:

Errorcode HTTP statuscode Description
bad_request 400 -
service_unavailable 503 Checking the registration status is currently unavailable.

Example domain registration status request

GET /domains/registrations/COM-20160329-101
Authorization: hmac 144...07f:Jxo...aiM=:2cb...dd3:1459425654
Accept: application/json, application/xml;q=0.8, */*;q=0.5

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Tue, 29 Mar 2016 20:11:05 GMT
X-Ratelimit-Limit: 10
X-Ratelimit-Usage: 4
{ 
    "order_code" : "COM-20160329-101",
    "status" : "Finished"
}