API Documentation

Control your servers via our easy-to-use API system.

Ubiquity offers an easy to use API for our customers that need a little bit more control to get exactly what they're looking for. Please view the functionality overview below.

Download API Libraries

Gaining API Access

You will need a Ubiquity API account to gain access to our core API.

Sample XML Message

* All messages are returned in a base64 encoded, serialized format.

XML Message
----------------------------------------------
<?xml version="1.0" encoding="UTF-8"?>
<listDedicatedServers xmlns="http://api.ubiquityservers.com/schemas/customer">
<remoteid>customerTest</remoteid>
<remotekey>422612e1e235b74efa39077028bd04ce</remotekey>
<resellerid>2</resellerid>
<parameters>
</parameters>
</listDedicatedServers>

Sample XML Return

* All messages are returned in a base64 encoded, serialized format.

XML Return
----------------------------------------------
<?xml version="1.0" encoding="UTF-8"?>
<response>
<parameters>
<result>yIjtzOjE2OiIxNzQuMfsdajfsdaFDSAFdsafkdsajfsjalfsdaFDSAFDSAfdsfsdafzQuMTI5LjgwLzI5Ijt9fQ==</result>
</parameters>
</response>

Functions

cancelLicense - Cancel any licenses ordered using the API or CP.
cancelService - Process the immediate cancellation of a service.
disableSwitchPort - Disable a switch port that the device is connected to via the API.
enableSwitchPort - Enable a switch port that the device is connected to via the API.
getBalance - Retrieves the current account balance.
getBandwidthBilling - Get the bandwidth information for this service.
getBandwidthGraph - Retrieves a bandwidth graph for a specified server.
getDeviceOverview - Returns information about a specified server.
getHistory - Retrieve the history of invoices from your account.
getResellerPackagesWithOptions - List all package options that resellers have access to. Given example is 15% discount rate (highest tier). Discount levels vary from client to client.
getServiceOverview - Retrieve an overview of a specific service on your account.
getWelcomeMails - Return a list of your generated welcome emails
listColocationServers - List all of your co-located servers (colo) attached to your account.
listDedicatedServers - List all of your dedicated servers attached to your account.
listEndUserDedicated - Returns a list of dedicated servers owned by your customer.
listPaymentMethods - Retrieves a listing of payment methods stored on your account.
listPayments - List all the payments for a particular invoice.
listRdnsEntries - List a device's rDNS entries and IP assignments.
listVirtualServers - List all of your virtual servers (VPS) attached to your account.
orderLicense - Order a new software license via the API.
orderNewService - Place an order from the API
payInvoice - Pay an invoice via the API.
payPartialInvoice - Process a payment for a specific service on an invoice.
powerOff - Power a device off from the API.
powerOn - Power a device on from the API.
retrieveKey - For control panel licenses that require you to install a key (ie. all Parallels licenses), you may use this function to retrieve their current license key.
submitIpJustification - Submit IP Justification via our API system
submitSwipRequest - Submit SWIP request via our API system.
updateFriendlyLabel - Updates a device label.
updateRdnsEntry - This function updates a particular IP address' associated rDNS entry record (PTR).
updateTemplateFile - Updates a template file for your control panel.