Loopia API

getCustomers

This method retrieves all of the clients connected to a reseller. Syntax customer_obj[] = getCustomers(username, password) Return value customer_obj[], the... [...]

LoopiaAPI

LoopiaAPI gives you the functionality available in Loopia Customer zone and Loopia Resellerzone via XML-RPC. In this way, you have... [...]

This method retrieves information for an order created by createNewAccount. Syntax order_status_obj = getOrderStatus(username, password, order_reference) Return value order_status_obj, method returns... [...]

transferCreditsByCurrency

This method transfers LoopiaPrePAID credits deposited after 2015-12-04 from one account to another. Syntax status = transferCreditsByCurrency(username, password, sender_number, recipient_number,... [...]

Create account and register the domain (Ruby)

This example shows how a reseller via Ruby connects to our XML-RPC server, creates a hosting account and registers a... [...]

createNewAccount

This method adds a new Loopia account and registers the domain that is used as username if this is provided... [...]

Create account and register the domain (Python)

This example shows how a dealer via Python connects to our XML-RPC server, creates a hosting account and registers a... [...]

order_status_obj

Struct that describes the order status for orders created bycreateNewAccount. Data Type struct. The value of all of the fields... [...]

domain_configuration

Configuration options for domain names. Data Type string Valid values [...]

record_obj

Struct that describes an entry in the DNS zone for a domain name. Data Type struct. The value of all... [...]

account_type

Account for Loopia accounts. Data Type string Valid values LOOPIADOMAINLoopiaDomain account LOOPIADNSLoopiaDNS account. EMAIL_PRIVATEEmail package. STARTERStarter package. HOSTING_PRIVATEWeb hosting Home.... [...]

order_status

Status of orders created by createNewAccount. Data Type string Valid values [...]

customer_obj

Struct describing a customer. Data Type struct. The value of all of the fields are shown below. Field [...]

invoice_item_obj

Struct describing a billing record. Data Type struct. The value of all of the fields are shown below. Field [...]

Create account and register the domain (Perl)

This example shows how a reseller via Perl connects to our XML-RPC server, creates a hosting account and registers a... [...]

Error codes

Error Code Error Code Meaning 404 Unknown error. 401 Login credentials not valid. 429 Rate limit exceeded. 620 Method doesn’t... [...]

Loopia API – Before you begin

Character encoding Any input is expected to be encoded in UTF-8. Server and authentication In order to use LoopiaAPI you must... [...]

transferDomain

This method starts a transfer to Loopia of a domain name that is in a Loopia account. Please note that... [...]

updateDNSServers

This method change the name servers for the specified domain name. Syntax status = updateDNSServers(username, password, [customer_number,] domain, nameservers) Return... [...]

invoice_obj

Struct describing a bill. Data Type struct. The value of all of the fields are shown below. Field [...]

contact

Struct describing a contact that can be used as an owner, administrative contact or billing contact to a domain name.... [...]

status

Status code for methods that don´t return data. Data Type string Valid values OKEverything is ok. AUTH_ERRORWrong username or password.... [...]

createNewAccount

This method adds a new Loopia account and registers the domain that is used as username if this is provided... [...]

domain_obj

Struct that describes a domain name. Data Type struct.The value of all of the fields are shown below. Field [...]

Order domain to an existing account (Perl)

This example shows how to use Perl to connect to our XML-RPC server and register a domain that is paid... [...]

getZoneRecords

This method retrieves a list of all of the DNS records for the specified subdomain. Syntax record_obj[] = getZoneRecords(username, password,... [...]

create_account_status_obj

Struct that describes the return status of orders created with createNewAccount. Data Type struct. The value of all of the fields... [...]

getDomains

This method retrieves all domains from one account. See also getDomain. Syntax domain_obj[] = getDomains(username, password, [customer_number]) Return value domain_obj[], the... [...]

domainIsFree

This method checks if the specified domain name is available for registration. Syntax status = domainIsFree(username, password, domain) Return value... [...]

renewal_status

Renewal status for a domain name. Data Type string Valid values [...]

getSubdomains

This method retrieves a list of all subdomains for the given domain name. Syntax subdomain[] = getSubdomains(username, password, [customer_number,] domain)... [...]

updateZoneRecord

This method updates a specific DNS entry for the specified subdomain. Syntax status = updateZoneRecord(username, password, [customer_number,] domain, subdomain, record_obj)... [...]

addZoneRecord

This method adds a DNS record for the specified subdomain. Syntax status = addZoneRecord(username, password, [customer_number,] domain, subdomain, record_obj) Return... [...]

addSubdomain

This method connects a subdomain to a domain name. Syntax status = addSubdomain(username, password, [customer_number,] domain, subdomain) Return value status,... [...]

getCreditsAmount

This method retrieves current Loopia Prepaid balance in current currency deposited after 2015-12-04. Syntax double = getCreditsAmount(username, password [, customer_number]... [...]

orderDomain

This method adds a new domain in an existing Loopia account to register this. Syntax status = orderDomain(username, password, [customer_number,]... [...]

removeDomain

This method removes a domain name from the account. If the domain name is removed it means that it will... [...]

getUnpaidInvoices

This method retrieves all unpaid domains from one account. See also getInvoice Syntax invoice_obj[] = getInvoice(username, password [, customer_number], with_vat) Return... [...]

getInvoice

This method retrieves information about an invoice in one account. Syntax invoice_obj = getInvoice(username, password [, customer_number], reference_no, with_vat) Return... [...]

getDomain

This method retrieves information about a domain name in an account. Among other things this is used to find out... [...]

removeSubdomain

This method removes a subdomain of a domain name in the specified account. Syntax status = removeSubdomain(username, password, [customer_number,] domain,... [...]

addDomain

This method adds an existing domain name to an existing Loopia account. Syntax status = addDomain(username, password, [customer_number,] domain) Return... [...]

payInvoiceUsingCredits

This method will pay an invoice with LoopiaPrePAID credits provided that the right amount is availible in the account. Syntax... [...]

removeZoneRecord

This method removes a specific DNS record from the specified subdomain. Syntax status = removeZoneRecord(username, password, [customer_number,] domain, subdomain, record_id)... [...]

Loopia API

Support

Knowledge Base