Introductie

Dit document beschrijft de Freenom API op technisch niveau. Het verklaart de ondersteunde data formats en hoe te communiceren met de API. Voor elke functie die wordt ondersteund door de API wordt een beschrijving gegeven, waaronder een voorbeeld van hoe een dergelijke function call en respons eruit kunnen zien.

Er worden voorbeelden gegeven met behulp van de command-line tool "curl". Curl is een eenvoudig hulpmiddel om toegang te krijgen tot URLs en is geïnstalleerd op de meeste Unix-achtige omgevingen.

 

Data formats

The API delivers output in JSON format by default. If the API User prefers, output can be given in XML. The method of output is defined in the function call.

Voorbeeld: Ping the service

Input
Vraag
Output
Antwoord

Voorbeeld: Ping the service expecting XML output. Note the .xml behind the method name.

Input
Vraag
Output
Antwoord

Examples in this manual are given in XML for readability.


 

Interacting with Freenom API

Interaction with the API should be trivial. The service is a RESTful-like service that interacts over HTTPS. Of all the HTTP methods available, only GET and POST are used. GET calls retrieve information and do not change anything, while POST calls are meant to change data.

POST calls are idempotent for 30 seconds. This allows a caller to resubmit a transaction having it not being executed twice.


 

Common errors

Each function supported by the API has been documented thoroughly. Some errors can occur for a multiple of functions and are described in this chapter. This information will not be repeated in the related function description.

Function not found

In case an unsupported function is called, the service will reply the following:

Not authorized

Most functions can only be executed by authorized users. For these functions authorization must take place. If the user is not authorized to make the call, the content returned will be:

Invalid data submitted

If the function itself is supported, but data submitted is invalid or missing an error will be reported. For example:

Input
Vraag
Output
Antwoord

The status field will state 'error' when an error occurred. Whenever this field is set to 'error', an element will display the error found.

The service will always reply directly when a first error is found. If there are multiple errors in the function call, only one is returned. This stops the service from doing unnecessary work, as the call will fail in any case.


 

Function parameters

Commonly used parameters

A number of parameters are used in a multiple of functions. Other parameters deserve special attention. Those parameters are explained in this chapter.

domainname

The domain name involved. The domain name should consist of only a-z and 0-9 characters and the - (dash). The dash may not be in the beginning or end of the domain name. Domain names are not case sensitive

forward_url

If the domain is configured for forwarding, the URL to forward traffic for the domain to is given via the forward_url. The forward_url can be any HTTP or HTTPS URL.

nameserver

The nameserver. A nameserver needs to be a hostname that is resolvable if it's a hostname not under the domain name specified.

period

The period of domain registration or renewal. Paid domains are registered in number of years. Supported periods for Paid domains: 1Y, 2Y, 3Y, 4Y, 5Y, 9Y and 10Y. Free domains are registered in number of months. Supported periods for Free domains: 1M - 12M.

idshield

ID Shield is a FREE privacy service that is designed to protect you. Your personal information is not exposed in the WHOIS database, while emails are automatically forwarded - after human interface detection - to the email address we have on file. The two possible values of the parameter: enabled or disabled.

 

Supporting parameters

Supporting parameters are parameters that are not specific to a function call but to the API behavior.

test_mode

When set to 1, the function is discarded after execution. Any changes done to Freenom's database are rolled back.

method

If caller is unable to specify the method of the function by that method, this parameter can help. Setting the method parameter to 'post' will tell the service that a POST method is meant by caller. Same counts for 'get', 'put' and 'delete'.

 

The multiple flag

Function parameters are described in a table for each function. One of the columns in this table is labeled "multiple". This indicates whether or not the parameter can be specified more than once.

An example call would look like this:

 

API functions

 

Ping the service

Input
URL: https://api.freenom.com/v2/service/ping
Methode: GET
Input
Beschrijving: This function allows the user to check the status of the server. The server will return its latest timestamp.

Parameters: Geen.

Teruggegeven waarden
Eigenschap Beschrijving
result PING REPLY
timestamp YYYY-MM-DD HH24:MI:SS UTC
status OK

 

Voorbeeld:

Input
Vraag
Output
Antwoord

 


Search for available domains

Input
URL: https://api.freenom.com/v2/domain/search
Methode: GET
Input
Beschrijving: This function allows the API user to search a domain for availability.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
email E-mail address used for authentication Nee Nee
password Password used for authentication Nee Nee
domaintype The type of the domain: PAID or FREE Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result DOMAIN AVAILABLE or DOMAIN NOT AVAILABLE Beide
domain One or multiple hashes with result of domain name search Beide
 domainname The domain name as requested Beide
 domaintype The domaintype of the searched domain name. Beide
 pricing Multiple hashes of pricing info for domainname. Betaald
  currency The currency for given prices Betaald
  period The registration period for given price. Betaald
  partnerprice The amount to be paid by the reseller Betaald
  retailprice The amount to be paid by the enduser. (public price) Betaald
 status AVAILABLE or NOT AVAILABLE Beide
status OK Beide

 

Voorbeeld: Check the availability of domain test001.tk

Input
Vraag
Output
Antwoord

Register a domain

Input
URL: https://api.freenom.com/v2/domain/register
Methode: POST
Input
Beschrijving: Use this function to register a domain.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
period The period of registration. If not given it will default to 1Y for paid domains and will default to 3M for free domains Nee Nee
forward_url The URL the domain name should forward to Nee* Nee
forward_mode The type of forward. Can be cloak or 301_redirect. cloak is default. Nee Nee
nameserver Nameserver to use. A minimum of 2 nameservers is required Nee* Ja
owner_id Contact ID of domain owner Ja** Nee
billing_id Contact ID of billing contact Nee Nee
tech_id Contact ID of technical contact Nee Nee
admin_id Contact ID of admin contact Nee Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee
domaintype The type of the domain: PAID or FREE Ja Nee
idshield Identity protection parameter, possible values : enabled or disabled Nee** Nee
autorenew Autorenewal setting for this domain. Possible values: enabled or disabled. Nee Nee


Notes: * forward_url and nameservers are mutual exclusive. Either the forward_url OR nameservers need to be specified. It is not possible to specify both. In case the nameserver is under the same domain, a glue record must be created for this domain. This can be done by registering Nameserver records.

** In case idshield is enabled owner_id doesn't need to be specified.

Teruggegeven waarden
Eigenschap Beschrijving Type
result DOMAIN REGISTERED or NOT AVAILABLE Beide
domain One or multiple hashes with result of domain name registration Beide
 currency The currency for given prices Betaald
 domainname The domain name as requested Beide
 domaintype The domaintype of the checked domainname Beide
 expirationdate The date the domain will expire in YYYYMMDD Beide
 period The registration period of the registered domainname Beide
 partnerprice The amount to be paid by the reseller Betaald
 retailprice The amount to be paid by the enduser. (public price) Betaald
 owner_id Contact ID of domain owner Betaald
 tech_id Contact ID of technical contact Betaald
 billing_id Contact ID of billing contact Betaald
 admin_id Contact ID of administrative contact Betaald
 status REGISTERED or NOT AVAILABLE Beide
 authcode Generated authorization code Betaald
 autorenew Autorenewal flag. Either enabled or disabled. Betaald
status OK Beide

 

Voorbeeld: Registering a domain for 2 years with nameservers under the domain.

Input
Vraag
Output
Antwoord

Renew a domain name registration

Input
URL: https://api.freenom.com/v2/domain/renew
Methode: POST
Input
Beschrijving: This function must be used to renew a domain registration.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
period The period of registration. If not given it will default to 1Y for paid domains and will default to 3M for free domains Nee Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee
Teruggegeven waarden
Eigenschap Beschrijving Type
result DOMAIN RENEWED or NOT AVAILABLE Betaald
domain One or multiplehashes with result of domain name renewal Beide
 currency The currency for given prices Betaald
 domainname The domain name as requested Beide
 domaintype The domaintype of the checked domainname Beide
 expirationdate The date the domain will expire in YYYYMMDD Beide
 period The registration period of the registered domainname Beide
 partnerprice The amount to be paid by the reseller Betaald
 retailprice The amount to be paid by the enduser. (public price) Betaald
 owner_id Contact ID of domain owner Betaald
 tech_id Contact ID of technical contact Betaald
 billing_id Contact ID of billing contact Betaald
 admin_id Contact ID of administrative contact Betaald
 status RENEWED or NOT AVAILABLE Beide
status OK Beide

 

Voorbeeld: Renewal of paid domain TEST001.TK for three years.

Input
Vraag
Output
Antwoord

Get info on registered domain names

Input
URL: https://api.freenom.com/v2/domain/getinfo
Methode: GET
Input
Beschrijving: Retrieve information about a domain registered by the requesting user.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee
Teruggegeven waarden
Eigenschap Beschrijving Type
result DOMAIN LISTED Beide
domain One or multiple hashes with result of domain name search Beide
 domainname The domain name as requested Beide
 domaintype The domaintype of the checked domainname Beide
 expirationdate The date the domain will expire in YYYYMMDD Beide
 authcode The authorization code Betaald
 autorenew Autorenewal flag. Either enabled or disabled. Betaald
 pricing Multiple hashes with pricing info for domain name Betaald
  currency The currency for given prices Betaald
  period The registration period of the checked domainname Betaald
  partnerprice The amount to be paid by the reseller Betaald
  retailprice The amount to be paid by the enduser. (public price) Betaald
 status ACTIVE or CANCELLED; Status of the domain Beide
 forward_url The URL the domain name should forward to Beide
 forward_mode The type of forward. Can be cloak or 301_redirect. cloak is default. Beide
 nameserver Zero or multiple hashes with nameserver info Beide
  hostname Hostname of nameserver Beide
  ipaddress IP address of nameserver if glue present Beide
 owner_contact Hash containing contact data of owner Betaald
  contact_id Contact ID of owner contact Betaald
  contact_title Title of contact; Mr, Mrs, etc. Betaald
  contact_firstname Firstname of contact Betaald
  contact_middlename Middle name of owner contact Betaald
  contact_lastname Lastname of owner contact Betaald
  contact_organization Organization name of owner (if any) Betaald
  contact_address Address of owner contact Betaald
  contact_city City of owner contact Betaald
  contact_zipcode Zipcode of owner contact Betaald
  contact_statecode Statecode (ISO 3166-2) of owner contact Betaald
  contact_countrycode Countrycode (ISO 3166-1) of owner contact Betaald
  contact_phone Phone number of owner contact Betaald
  contact_fax Fax number of owner contact Betaald
  contact_email Email address of owner contact Betaald
 admin_contact Hash containing contact data of admin Betaald
  contact_id Contact ID of admin contact Betaald
  contact_title Title of contact; Mr, Mrs, etc. Betaald
  contact_firstname Firstname of admin contact Betaald
  contact_middlename Middle name of admin contact Betaald
  contact_lastname Last name of admin contact Betaald
  contact_organization Organization name of admin (if any) Betaald
  contact_address Address of admin contact Betaald
  contact_city City of admin contact Betaald
  contact_zipcode Zipcode of admin contact Betaald
  contact_statecode Statecode (ISO 3166-2) of admin contact Betaald
  contact_countrycode Countrycode (ISO 3166-1) of admin contact Betaald
  contact_phone Phone number of admin contact Betaald
  contact_fax Fax number of admin contact Betaald
  contact_email Email address of admin contact Betaald
 tech_contact Contact ID of tech contact Betaald
  contact_id Contact ID of tech contact Betaald
  contact_title Title of contact; Mr, Mrs, etc. Betaald
  contact_firstname Firstname of tech contact Betaald
  contact_middlename Middlename of tech contact Betaald
  contact_lastname Lastname of tech contact Betaald
  contact_organization Organization name of tech (if any) Betaald
  contact_address Address of tech contact Betaald
  contact_city City of tech contact Betaald
  contact_zipcode Zipcode of tech contact Betaald
  contact_statecode Statecode (ISO 3166-2) of tech contact Betaald
  contact_countrycode Countrycode (ISO 3166-1) of tech contact Betaald
  contact_phone Phone number of tech contact Betaald
  contact_fax Fax number of tech contact Betaald
  contact_email Email address of tech contact Betaald
 billing_contact Hash containing contact data of billing contact Betaald
  contact_id Contact ID of billing contact Betaald
  contact_title Title of contact; Mr, Mrs, etc. Betaald
  contact_firstname Firstname of billing contact Betaald
  contact_middlename Middlename of billing contact Betaald
  contact_lastname Lastname of billing contact Betaald
  contact_organization Organization name of billing (if any) Betaald
  contact_address Address of billing contact Betaald
  contact_city City of billing contact Betaald
  contact_zipcode Zipcode of billing contact Betaald
  contact_statecode Statecode (ISO 3166-2) of billing contact Betaald
  contact_countrycode Countrycode (ISO 3166-1) of billing contact Betaald
  contact_phone Phone number of billing contact Betaald
  contact_fax Fax number of billing contact Betaald
  contact_email Email address of billing contact Betaald
status OK Beide

 

Voorbeeld: Customer retrieves info on domain TEST002.TK.

Input
Vraag
Output
Antwoord

Modifying a domain

Input
URL: https://api.freenom.com/v2/domain/modify
Methode: PUT
Input
Beschrijving: If a domain's DNS settings or URL forwarding is to be updated, this function will offer functionality for that.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
forward_url The URL the domain name should forward to Nee* Nee
forward_mode The type of forward. Can be cloak or 301_redirect. cloak is default. Nee Nee
nameserver Nameserver to use. Minimally 2 are needed Nee* Ja
owner_id Contact ID of domain owner Nee Nee
admin_id Contact ID of administrative contact Nee Nee
tech_id Contact ID of technical contact Nee Nee
billing_id Contact ID of billing contact Nee Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee
idshield Identity protection parameter, possible values : enabled or disabled Nee Nee
autorenew Autorenewal setting for this domain. Possible values: enabled or disabled. Nee Nee

 

Notes: * forward_url and nameservers are mutual exclusive. Either the forward_url OR nameservers need to be specified. It is not possible to specify both. In case the nameserver is under the same domain, a glue record must be created for this domain. This can be done by registering Nameserver records.

 

Teruggegeven waarden
Eigenschap Beschrijving Type
domain One or multiple hashes with result of domain name modification Allemaal
 domainname The requested domain name Allemaal
 status MODIFIED Allemaal
result DOMAIN MODIFIED Allemaal
status OK Allemaal

 

Voorbeeld: Modify domain TEST002.TK, having it forward to http://www.freedomregistry.com/

Input
Vraag
Output
Antwoord

Deleting a domain

Input
URL: https://api.freenom.com/v2/domain/delete
Methode: DELETE
Input
Beschrijving: This function will delete the domain from the account. The domain name will immediately be available to other registrants once it has been cancelled.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
domain One or multiple hashes with result of domain deletion Allemaal
 domainname Domain name that was deleted Allemaal
 status DELETED Allemaal
 result DOMAIN DELETED Allemaal
status OK Allemaal

 

Voorbeeld: Delete TEST002.TK

Input
Vraag
Output
Antwoord

Restore a domain

Input
URL: https://api.freenom.com/v2/domain/restore
Methode: POST
Input
Beschrijving: This function will restore a domain to the account if possible
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
domain One or multiple hashes with result of domain restore Allemaal
 domainname Domain name that was restored Allemaal
 result DOMAIN RESTORED Allemaal
 status RESTORED Allemaal
status OK Allemaal

 

Voorbeeld:

Input
Vraag
Output
Antwoord

Upgrade a domain

Input
URL: https://api.freenom.com/v2/domain/upgrade
Methode: POST
Input
Beschrijving: Upgrade a free domain to paid domain
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee
owner_id Contact ID of owner contact Nee** Nee
billing_id Contact ID of billing contact Nee Nee
admin_id Contact ID of admin contact Nee Nee
tech_id Contact ID of technical contact Nee Nee
idshield Identity protection parameter, possible values : enabled or disabled Nee** Nee
period Number of years to add to domain expiration, after the domain has been upgraded. Ja Ja

Opmerkingen: ** In case idshield is enabled owner_id doesn't need to be specified.

Teruggegeven waarden
Eigenschap Beschrijving Type
domain One or multiple hashes with result of domain upgrade Allemaal
 domainname Domain name that was upgraded Allemaal
 result DOMAIN UPGRADED Allemaal
 status UPGRADED Allemaal
status OK Allemaal

 

Voorbeeld: Upgrade a free domain to paid domain

Input
Vraag
Output
Antwoord

List domains in account

Input
URL: https://api.freenom.com/v2/domain/list
Methode: GET
Input
Beschrijving: Lists all domains under the account
Parameters
Parameter Beschrijving Vereist Meerdere
pagenr Page number of results. Defaults to 1 Nee Nee
results_per_page Number of results per page. Defaults to 25 Nee Nee
email E-mail address used for authentication Nee Nee
password Password used for authentication Nee Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
domain One or multiple hashes with result of domain deletion Beide
 domainname The name of the domain Beide
 domaintype Type of the domain Beide
 registrationdate The date the domain was registered in YYYYMMDD Beide
 expirationdate The date the domain will expire in YYYYMMDD Beide
 status ACTIVE or CANCELLED; Status of the domain Beide
 authcode The authorization code Betaald
 autorenew Autorenewal flag. Either enabled or disabled. Betaald
result <nr> DOMAINS FOUND Beide

 

Voorbeeld:

Input
Vraag
Output
Antwoord

Register or modify a nameserver glue record

Input
URL: https://api.freenom.com/v2/nameserver/register
Methode: PUT
Input
Beschrijving: When the domain's DNS is managed by custom nameservers and the nameservers are under the domain, nameserver glue records are required to get the domain working. Nameserver glue records can be registered using this function.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname Domain name of glue record Ja Nee
hostname Domain name of glue record Ja Nee
ipaddress Value of DNS record Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result NAMESERVER REGISTERED or NAMESERVER UPDATED Allemaal
nameserver One or multiple hashes with result of nameserver registration Allemaal
 domainname Domain name of zone to add DNS record Allemaal
 hostname The hostname of the glue record Allemaal
 ipaddress The IP address of the glue record Allemaal
 status REGISTERED or UPDATED Allemaal
status OK Allemaal

 

Voorbeeld: Register a nameserver glue for TEST002.TK

Input
Vraag
Output
Antwoord

Deleting a nameserver glue record

Input
URL: https://api.freenom.com/v2/nameserver/delete
Methode: DELETE
Input
Beschrijving: Nameserver glue records registered via the nameserver/register method can be deleted via this function. nameservers are under the domain, nameserver glue records are required to get the domain working. Nameserver glue records can be registered using this function.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname Domain name of glue record Ja Nee
hostname The hostname to delete Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result NAMESERVER DELETED Allemaal
nameserver One or multiple hashes with result of nameserver delete Allemaal
 domainname Domain name of zone Allemaal
 hostname The nameserver that was deleted Allemaal
 status DELETED Allemaal
status OK Allemaal

 

Voorbeeld: Register a nameserver glue for TEST002.TK

Input
Vraag
Output
Antwoord

Listing nameserver glue records under a domain

Input
URL: https://api.freenom.com/v2/nameserver/list
Methode: GET
Input
Beschrijving: This function is used to retrieve a list of nameserver glue records registered under a domain name.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The domain name to list nameserver glue for Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result ENTRIES - number of entries found Allemaal
nameserver Name for DNS record Allemaal
 domainname The requested domain name Allemaal
 hostname Value for DNS record Allemaal
 ipaddress IP addres linked to the nameserver host Allemaal
status OK Allemaal

 

Voorbeeld: Requesting the DNS names registered under TEST002.TK

Input
Vraag
Output
Antwoord

 

Functions related to contact management

 

Create or Modify contact

Input
URL: https://api.freenom.com/v2/contact/register
Methode: PUT
Input
Beschrijving: Creating a new contact can be done with this function. The contact is not linked to any domain after being created; this needs to be done by new domain registration or modification.
Parameters
Parameter Beschrijving Vereist Meerdere
contact_organization Organization name of contact Nee Nee
contact_title Title of the contact Nee Nee
contact_firstname First name of contact Ja Nee
contact_middlename Middle name of contact Nee Nee
contact_lastname Last name of contact Ja Nee
contact_address Address of the contact Ja Nee
contact_city City of the contact Ja Nee
contact_zipcode Zipcode of the contact Ja Nee
contact_statecode ISO-3166 code for state Ja Nee
contact_countrycode ISO-3166 code for country Ja Nee
contact_phone Phone number of contact (international format) Ja Nee
contact_fax Fax number of contact (international format) Nee Nee
contact_email Email address of contact Ja Nee
contact_id ID of existing contact Nee Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result CONTACT REGISTERED / CONTACT UPDATED Betaald
contact One or multiple hashes with contacts affected Betaald
 contact_id ID of the registered or updated contact Betaald
 status REGISTERED / UPDATED Betaald
status OK Betaald

 

Voorbeeld: Register Contact

Input
Vraag
Output
Antwoord

 


Delete contact

Input
URL: https://api.freenom.com/v2/contact/delete
Methode: DELETE
Input
Beschrijving: Deleting a new contact can be done with this function. Contacts can only be deleted if they are not linked to any domain.
Parameters
Parameter Beschrijving Vereist Meerdere
contact_id ID of contact Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result CONTACT DELETED Betaald
contact One or multiple hashes with contacts affected Betaald
 contact_id ID of the deleted Betaald
 status DELETED Betaald
status OK Betaald

 

Voorbeeld: Delete Contact

Input
Vraag
Output
Antwoord

 


Get info on specific contacts

Input
URL: https://api.freenom.com/v2/contact/getinfo
Methode: GET
Input
Beschrijving: List details of contacts under user account.
Parameters
Parameter Beschrijving Vereist Meerdere
contact_id One or more contact id to get info on Ja Ja
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result CONTACTS LISTED Betaald
contact Array of one or multiple contacts Betaald
 contact_id ID of contact Betaald
 contact_title Title of the contact Betaald
 contact_firstname First name of contact Betaald
 contact_middlename Middle name of contact Betaald
 contact_lastname Last name of contact Betaald
 contact_organization Organization name of contact Betaald
 contact_address Address of the contact Betaald
 contact_city City of the contact Betaald
 contact_zipcode Zipcode of the contact Betaald
 contact_statecode Country of contact Betaald
 contact_countrycode State of contact Betaald
 contact_phone Phone number of contact (international format) Betaald
 contact_fax Fax number of contact (international format) Betaald
 contact_email Email address of contact Betaald
 contact_domain Array of one or multiple domains contact is linked to Betaald
  domainname Name of domain contact is linked to Betaald
  type Contact type (eigenaar, technisch, administratief of financieel) Betaald
status OK Betaald

 

Voorbeeld: Get info on one contact_id

Input
Vraag
Output
Antwoord

 


List contacts under account

Input
URL: https://api.freenom.com/v2/contact/list
Methode: GET
Input
Beschrijving: List all contacts under users account.
Parameters
Parameter Beschrijving Vereist Meerdere
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result CONTACTS LISTED Betaald
contact Array of one or multiple contacts Betaald
 contact_id ID of contact Betaald
 contact_title Title of the contact Betaald
 contact_firstname First name of contact Betaald
 contact_middlename Middle name of contact Betaald
 contact_lastname Last name of contact Betaald
 contact_organization Organization name of contact Betaald
 contact_address Address of the contact Betaald
 contact_city City of the contact Betaald
 contact_zipcode Zipcode of the contact Betaald
 contact_statecode Country of contact Betaald
 contact_countrycode State of contact Betaald
 contact_phone Phone number of contact (international format) Betaald
 contact_fax Fax number of contact (international format) Betaald
 contact_email Email address of contact Betaald
 contact_domain Array of one or multiple domains contact is linked to Betaald
  domainname Name of domain contact is linked to Betaald
  type Contact type (eigenaar, technisch, administratief of financieel) Betaald
status OK Betaald

 

Voorbeeld: List Contacts.

Input
Vraag
Output
Antwoord

 

Functions related to domain transfers

 

Get price of a domain transfer

Input
URL: https://api.freenom.com/v2/domain/transfer/price
Methode: GET
Input
Beschrijving: Transfers are made by gaining partners that use an obtained authorization code from the registrant or the losing partner. All transfers are subject to a one year renewal. Before a transfer is made the gaining partner may request the retail price and partner price of the transfer (and therefore the one year renewal). This API call only provides prices and does not perform the actual transfer.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The domainname Ja Nee
authcode The authorization code Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
transfer Array of one or multiple transfers Betaald
 domainname Domain name updated Betaald
 domaintype Type of the domain Betaald
 period Length of renewal after transfer; always 1Y Betaald
 currency The currency for given prices Betaald
 retailprice Price for registrant Betaald
 partnerprice Price for partner Betaald
result PRICES PROVIDED Betaald
status OK Betaald

 

Voorbeeld: Request transferprice for TEST002.TK

Input
Vraag
Output
Antwoord

 


Request a domain transfer

Input
URL: https://api.freenom.com/v2/domain/transfer/request
Methode: POST
Input
Beschrijving: Transfer requests are performed by resellers that wish to transfer domain names from other resellers or registrars to their own account.
Please note: A domain transfer for a .TK, .ML, .CF, .GA or .GQ domain will be directly approved if the request has the correct authorization code.

Parameters
Parameter Beschrijving Vereist Meerdere
domainname The name of the domain Ja Nee
authcode The authorization code Ja Nee
period Number of years to renew the domain. Defaults to 1Y Ja Nee
owner_id contact_id of new owner Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result TRANSFER REQUESTED Betaald
transfer Array of one or more transfers Betaald
 domainname Domain name updated Betaald
 status REQUESTED Betaald
status OK Betaald

 

Voorbeeld: Transfer domain TEST002.TK to our account

Input
Vraag
Output
Antwoord

 


Approve a domain transfer

Input
URL: https://api.freenom.com/v2/domain/transfer/approve
Methode: POST
Input
Beschrijving: Approve an outgoing domain transfer.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The domainname Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result TRANSFER APPROVED Betaald
transfer Array of one or more transfers Betaald
 domainname Domain name updated Betaald
 status APPROVED Betaald
status OK Betaald

 

Voorbeeld: Approce transfer of domainTEST002.TK from our account.

Input
Vraag
Output
Antwoord

 


Decline a domain transfer

Input
URL: https://api.freenom.com/v2/domain/transfer/decline
Methode: POST
Input
Beschrijving: Decline an outgoing domain transfer.
Parameters
Parameter Beschrijving Vereist Meerdere
domainname The domain name Ja Nee
reason Reason of declining the transfer Ja Nee
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result TRANSFER DECLINED Betaald
transfer Array of one or more transfers Betaald
 domainname Domain name updated Betaald
 status DECLINED Betaald
status OK Betaald

 

Voorbeeld: Decline a domain transfer of TEST002.TK from our account.

Input
Vraag
Output
Antwoord

 


List current domain transfers

Input
URL: https://api.freenom.com/v2/domain/transfer/list
Methode: GET
Input
Beschrijving: Retrieve a list of domain transfers. Domain transfers that are in final status approved or declined will be listed for a week after the transfer update.
Parameters
Parameter Beschrijving Vereist Meerdere
email E-mail address used for authentication Ja Nee
password Password used for authentication Ja Nee

 

Teruggegeven waarden
Eigenschap Beschrijving Type
result TRANSFERS LISTED Betaald
transfer Zero, one or multiple entries containing information about the domain transfer Betaald
 domainname The name of the domain Betaald
 transfertype Ingaand of uitgaand Betaald
 status Status of the transfer. PENDING, APPROVED, DECLINED Betaald
 newregistrar In case of outgoing transfer, name of new registrar Betaald
 lastupdate Date of last update Betaald

 

Voorbeeld: Retrieve a list of domain transfers

Input
Vraag
Output
Antwoord