NewServers: Bare Metal Cloud - XML over HTTPS API

Support | Contact Us | About Us | Blog

Questions? Call 888.71.SERVE (73783)

HARDWARE API INFRASTRUCTURE DOCUMENTATION

	Hourly Billing
	Automated Provisioning
	API
	Dedicated Servers & Disks

XML over HTTPS API

This is a collection of URL’s you can use to allocate and manage NewServers™ resources with any development environment that can open a URL and process XML.

Authentication
All API methods require authentication. Pass your login information using the username and password variables.

Parameters
Some API methods take optional and/or required parameters. Where applicable we have documented those parameters. Remember to convert to UTF-8 and URL encode parameters that take complex strings

Errors

If a problem occurs an error element is added to the responses root element with attributes indicating an error code and brief description.

What is the NewServers™ API?
Utilizing an https request with an XML response, we integrate with custom and third-party software and control panels, providing server provisioning, management, monitoring, and information retrieval from our systems.

Who would benefit the most from the API?
API access is offered to all NewServers™ clients and is especially useful to companies like:

Hosting Resellers
SaaS Integrators
VARS and clients with integrated IT management tools and systems
Gaming Providers
MMOG companies
Clients with current server management tools
Managed Services Firms

API Function Definitions

addServer - Order a new dedicated server

Parameters:
username - your username
password - your password
config - the hardware configuration of the server
os - the operating system installed on the server

Available config:
small
medium
Available operating systems:
Win2003
Centos5.4

Example request:
https://noc.newservers.com/api/addServer?username=you&password=yourpass&config=small&os=centos5.4

Example response:

<add-server-response> <confirmation>true</confirmation> <server> <id>1205</id> </server> </add-server-response>

cancelServer - Cancel a server

Parameters:
username - your username
password - your password
serverId - the id of the server you wish to cancel

Example request:
https://noc.newservers.com/api/cancelServer?username=you&password=yourpass&serverId=1225

Example response:

<cancel-server-response> <confirmation>true</confirmation> <server> <id>1225</id> </server> </cancel-server-response>

listPlans - Real-time access to information about available server configurations

Parameters:
username - your username
password - your password

Example request:
https://noc.newservers.com/api/listPlans?username=you&password=yourpass

Example response:

<list-plans-response> <plan> <id>1</id> <name>Linux Centos 5.5 64 bit</name> <description>Xeon 2.8 1GB Ram 73GB 10,000 RPM HD</description> <rate>0.11</rate> <os>Centos5.4</os> <config>small</config> </plan> <plan> <id>2</id> <name>Win2k3 Standard 64 bit</name> <description>Xeon 2.8 1GB Ram 73GB 10,000 RPM HD</description> <rate>0.13</rate> <os>Win2003</os> <config>small</config> </plan> </list-plans-response>

listActiveServers - Your active servers

Parameters:
Username - your username
Password - your password

Example request:
https://noc.newservers.com/api/listActiveServers?username=you&password=yourpass

Example response:

<list-servers-response> <confirmation>true</confirmation> <server> <id>1225</id> </server> </list-servers-response>

getServerInfo - Retrieve the ip address and login credentials for an active server

Parameters:
username - your username
password - your password
serverId - the id of the server whose information you wish to retrieve

Example request:
https://noc.newservers.com/api/getServerInfo?username=you&password=yourpass&serverId=1225

Example response:

<get-server-info-response> <server> <id>1225</id> <name>server2323</name> <notes>my db server</notes> <ip>204.10.111.97</ip> <ip>64.187.123.89</ip> <login> <name>Admin for users</name> <username>administrator</username> <password>testpass</password> </login> <login> <name>login for users</name> <username>subusers</username> <password>tespass2</password> </login> </server> </get-server-info-response>

rebootServer - System power cycle

Parameters:
Username - your username
Password - your password
serverId - the id of the server you wish to reboot

Example request:
https://noc.newservers.com/api/rebootServer?username=you&password=yourpass&serverId=1225

Example response:

<reboot-server-response> <confirmation>true</confirmation> <server> <id>1225</id> </server> </reboot -server-response>

getServerBandwidth - Real-time access to information about available server bandwidth usage in bytes

Parameters:
Username - your username
Password - your password
serverId - the id of the server you wish to get bandwidth usage
dateFrom - 2007-02-01, if omitted defaults to current months usage.
dateTo - 2007-02-28

Example request:
https://noc.newservers.com/api/getServerBandwidth?username=you&password=yourpass&serverId=1225&dateFrom=2007-02-01&dateTo=2007-02-28

Example response:

<get-server-bandwidth-response> <confirmation>true</confirmation> <server> <id>50</id> </server> </get-server-bandwidth-response>