Loopia API

LoopiaAPI

LoopiaAPI is the XML-RPC API that exposes the functionality of the Loopia Customer Zone and Loopia Reseller Zone, letting you... [...]

transferDomain

This method starts a transfer of a domain name to a Loopia account. Please note that for certain TLDs a... [...]

record_obj

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

getCustomers

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

Loopia API – Before you begin

Before you make your first call to the LoopiaAPI XML-RPC service, review the character encoding, server endpoint, authentication scheme and... [...]

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

getOrderStatus

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

updateDNSServers

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

createNewAccount

This method creates a new Loopia account and, if requested in the call, registers the domain name used as the... [...]

domain_configuration

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

addZoneRecord

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

contact

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

Create account and register the domain (Python)

This example shows how a reseller can use Python to connect to our XML-RPC server, create a hosting account and... [...]

Error codes

When a LoopiaAPI method call fails, the XML-RPC server returns a fault response containing a numeric faultCode and a human-readable... [...]

Create account and register the domain (Ruby)

This example shows how a reseller can use Ruby to connect to our XML-RPC server, create a hosting account and... [...]

order_status_obj

Struct that describes the order status for orders created by createNewAccount. Data type struct. The values of all the fields... [...]

status

Status code returned by methods that do not return data. Data type string Valid values OKEverything is OK. AUTH_ERRORWrong username... [...]

account_type

Identifies the type of a Loopia account. Data type string Valid values LOOPIADOMAINLoopiaDomain account. LOOPIADNSLoopiaDNS account. EMAIL_PRIVATEEmail package. STARTERStarter package.... [...]

orderDomain

This method adds a new domain name to an existing Loopia account and registers it. Syntax status = orderDomain(username, password,... [...]

order_status

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

Create account and register the domain (Perl)

This example shows how a reseller can use Perl to connect to our XML-RPC server, create a hosting account and... [...]

updateZoneRecord

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

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 name that is... [...]

customer_obj

Struct describing a customer. Data type struct. The fields are listed below. Fields [...]

addSubdomain

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

invoice_item_obj

Struct describing a single invoice line item. Data type struct. The values of all the fields are shown below. Fields [...]

invoice_obj

Struct describing an invoice. Data type struct. The values of all the fields are shown below. Fields [...]

addDomain

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

domain_obj

Struct that describes a domain name. Data type struct. The fields are listed below. Fields [...]

getZoneRecords

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

createNewAccount

Creates a new Loopia account and, if requested, registers the domain that is used as the account username. Syntax create_account_status_obj... [...]

removeDomain

This method removes a domain name from the account. Once removed, the domain name will no longer be renewed by... [...]

getDomains

This method retrieves all domain names in an account. See also getDomain. Syntax domain_obj[] = getDomains(username, password, [customer_number]) Return value... [...]

domainIsFree

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

getSubdomains

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

create_account_status_obj

Struct that describes the return status of orders created with createNewAccount. Data type struct. The fields are listed below. Fields... [...]

renewal_status

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

getCreditsAmount

This method retrieves the current Loopia Prepaid balance, in the current currency, for amounts deposited after 2015-12-04. Syntax float =... [...]

getDomain

This method retrieves information about a domain name in an account. Among other things, it is used to look up... [...]

removeSubdomain

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

removeZoneRecord

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

getUnpaidInvoices

This method retrieves all unpaid invoices for an account. See also getInvoice. Syntax invoice_obj[] = getUnpaidInvoices(username, password [, customer_number], with_vat)... [...]

getInvoice

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

payInvoiceUsingCredits

This method pays an invoice using LoopiaPrePAID credits, provided that the required amount is available in the account. Syntax status... [...]

Loopia API

Support

Knowledge Base