URL:

https://api.liquidweb.com/bleed/Cloud/Server/addToCart

Description:

Add a server and desired configuration to the cart. If a cart uuid is not provided a new cart will be generated automatically.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/clone

Description:

Clone a server. Returns the information about the newly created clone.

All of the optional fields are defaulted to the values on the original server if they aren't received. For cloning to a private parent, include the uniq_id of the parent server to be cloned to, along with the memory/diskspace/vcpu amounts (if different from the original).

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/create

Description:

Provision a new server. This fires off the build process, which does the actual provisioning of a new server on its parent. Each server consists of several distinct options:

	config_id: the id of the server configuration you wish to use.  For a list
	of available configs, see the cloud/config/list API method

	template: templates are the LiquidWeb-provided server OS images.  For a list
	of available templates, see the cloud/template/list API method

	image_id: rather that provisioning a LiquidWeb template, you can specify
	the id of a user-created image on your account.  Use the API method
	cloud/image/list to find any existing images you have, or cloud/image/create
	to create a new image from an existing server

	ip_count: the number of IPs you wish the server to have.  This defaults to
	1 IP, which is included in the base price.  Pricing for additional IPs can
	be found using the product/details API method.

	bandwidth_quota: the bandwidth plan you wish to use.  A quota of 0 indicates
	that you want as-you-go, usage-based bandwidth charges, but may not be
	permitted with all configs.  The remaining available quota options can be
	found with the product/details API method.

	backup_enabled: whether or not backups should be enabled.  Defaults to no.
	If this is not set to 1, neither of the following two options will be used.

	backup_plan: either 'quota' or 'daily', depending on whether you are
	choosing a quota-based backup plan or just a specific number of days to be
	backed up.

	backup_quota: for a 'daily' plan, this indicates the number of days to back
	up.  For a quota plan, this is the total number of GB to keep.  Available
	options are found with the product/details API method .

	public_ssh_key: optional public ssh key you want added to authorized_keys
	on your new server.  This should be a valid public ssh key, e.g. the contents
	of your id_rsa.pub file.

Beyond those options, we need the hostname of the server ('domain') and the root password you would like set on the server originally ('password').

More information about the returned data structure are found in the documentation for the cloud/server/details method.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/destroy

Description:

Kills a server. It will refund for any remaining time that has been prepaid, charge any outstanding bandwidth charges, and then start the workflow to tear down the server.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/details

Description:

Gets data relevant to a cloud (Storm) server.

Here's a rundown of what the returned fields mean:

	accnt: your account number

	active: a flag indicating whether the server has finished building

	backup_enabled: whether or not backups are enabled

	backup_plan: either 'quota' or 'daily', depending on which backup plan you
	have enabled.  If backups are not enabled, this field is empty.

	backup_quota: for a 'daily' plan, this indicates the number of days backed
	up. For a quota plan, this is the total number of GB of backups kept for
	this server. If backups are not enabled, this field is empty.

	backup_size: the number of GB your current backups are using

	bandwidth_quota: the number of GB of bandwidth included in your bill.
	O indicates as-you-go usage-based bandwidth.

	config_id: the id of the server configuration this server is using

	config_description: a more descriptive name for the server configuration
	assigned to this server. 'Storm 2GB', for example.

	create_date: the date and time when the server was created

	ip: the primary IP of the server

	ip_count: the number of IPs the server has assigned to it

	manage_level: 'self', 'core', or 'full', determined by which template you
	chose when creating the server

		self: Includes support for hardware, network and virtualization layers.

		core: Includes complete support of the base operating system as well as
		Apache, Mysql and PHP. Proactive service restoration is provided.

		full: Includes cPanel + Fantastico as well complete support of base
		operating system and all cPanel services. Proactive service restoration
		is provided.

	template: which OS image you have installed.  Even when you create a server
	from an image, the original OS image is returned here.

	template_description: a more informative description of the OS you are using
	on this server.  'CentOS 5.5 64bit Core-Managed', for example.

	uniq_id: the unique server identifier, made of 6 letters and numbers

	zone: the zone in which your server resides.  This is not yet useful, but is
	still provided as reference.  The zone identifiers may change.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/detailsForCart

Description:

Returns details to add a provisioned Cloud server to the cart.

Regions can have more than one zone and the latest zone in the region will be used unless otherwise specified in parameters.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/history

Description:

Get a list of notifications for a specific server. Information about the data returned can here be found in cloud/alerts/details

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/isSBSOptimized

Description:

An instance uses more memory when using Cloud Block Storage volumes. Normal cloud (Storm) instances have enough pad for this to not be an issue, but bare-metal runs very tight. To work around this we can have a bare-metal instance use less memory so that the parent OS has more. We call this Cloud Block Storage optimization. This method returns a boolean flag is_optimized which is true if the instance has been optimized and false otherwise.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/list

Description:

Retrieve a paginated list of cloud (Storm) servers on your account. A more detailed description of what is returned can be found in the documentation for the cloud/server/details method.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/reboot

Description:

Reboot a server. The 'force' flag will do a hard shutdown/boot of the server from the parent server.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/resize

Description:

Resize a server to a new configuration. Available config_ids can be found in cloud/config/list.

You will be billed for the prorated difference of the price of the new configuration compared to the price of your old configuration. The difference will be refunded or charged at your next billing date.

A server resize cannot cross zones.

When resizing to a larger configuration, the filesystem resize operation can be skipped by passing the 'skip_fs_resize' option. In this case, the storage associated with the new configuration is allocated, but not available immediately. The filesystem resize should be scheduled with the support team.

Skipping the filesystem resize is only possible when moving to a larger configuration. This option has no effect if moving to the same or smaller configuration.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/resizePlan

Description:

Use this method to determine if currently resizing your server to your chosen config_id would result in any downtime.

If there is no inventory available for the config_id, an exception will be raised.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/setSBSOptimized

Description:

Start the appropriate workflow to turn Cloud Block Storage optimization on or off. If the desired value that you pass is the same as the current state of your instance, this method is a no-op.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/shutdown

Description:

Stop a server. The 'force' flag will do a hard stop of the server from the parent server. Otherwise, it will issue a halt command to the server and shutdown normally.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/start

Description:

Boot a server. If the server is already running, this will do nothing.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/status

Description:

Gets the current status of a server, in relation to what processes are being run on its behalf.

The list of available statuses at this time are:

	Building
	Cloning
	Resizing
	Moving
	Booting
	Stopping
	Restarting
	Rebooting
	Shutting Down
	Restoring Backup
	Creating Image
	Deleting Image
	Restoring Image
	Re-Imaging
	Updating Firewall
	Updating Network
	Adding IPs
	Removing IP
	Destroying

If nothing is currently running, only the 'status' field will be returned with one of the following statuses:

	Failed
	Provisioning
	Running
	Shutdown
	Stopped

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

URL:

https://api.liquidweb.com/bleed/Cloud/Server/update

Description:

Update details about your server, including the backup and bandwidth plans, and the hostname ('domain') we have on file.

Updating the 'domain' field will not change the actual hostname on the server. It merely updates what our records show.

Parameters:

Returns:

Possible Errors:

Refer to the Error Handling documentation for the list of exception types