REST API Documentation

Description

METHOD: POST

ENDPOINT: https://subdomain.net/api/subdomains/availability

REQURIRED PARAMETERS: "searchTerm", "tldsToSearch"

To check the availability and premium prices of a domain you send the name and all tlds you want to check. For the moment you have to send the group_id to get reseller premium prices, otherwise you will get the premium prices for end customers.

Query
Response

Description

METHOD: POST

ENDPOINT: https://subdomain.net/api/subdomains

REQURIRED PARAMETERS: "domain", "registrant"

OPTIONAL PARAMETERS: "admin", "tech", "billing", "nameservers", "years"

The contact information has to be as illustrated in the example. At the moment you can register only for one year and is the default value. Nameservers are optional for registration and can be updated later.

The backend will not check, if you want to register a premium domain, please check this beforehand.

Query
Response

Description

METHOD: DELETE

ENDPOINT: https://subdomain.net/api/subdomains/{domain}

Deactivates domain and returns date when it can be registered again.

Response

Description

METHOD: GET

ENDPOINT: https://subdomain.net/api/subdomains/{domain}

REQURIRED PARAMETERS: "searchTerm", "tldsToSearch"

OPTIONAL PARAMETERS: "group_id"

Returns all relevant information, if authorized.

Response

Description

METHOD: PATCH

ENDPOINT: https://subdomain.net/api/subdomains

REQURIRED PARAMETERS: "domain"

OPTIONAL PARAMETERS: "admin", "tech", "billing", "nameservers", "years"

The contact information has to be as illustrated in the example. At the moment you can renew only for one year at a time. The backend will not check, if you want to renew a premium domain, please check this beforehand.

Query
Response

Description

METHOD: PATCH

ENDPOINT: https://subdomain.net/api/subdomains

REQURIRED PARAMETERS: "domain", "years"

OPTIONAL PARAMETERS: "admin", "tech", "billing", "nameservers"

To renew a domain you have to send the parameter "years", otherwise the backend will not renew the domain. At the moment you can renew only for one year at a time. The backend will not check, if you want to renew a premium domain, please check this beforehand.

Query
Response