URL:

https://api.liquidweb.com/v1/Cloud/Image/create

Description:

Fires off a process to image the server right now. Since the image won't be created immediately, we can't return the information about it.

Parameters:

Parameter	Type	Notes
name	A string permitting tabs, carriage returns and newlines (Maximum length: 80)	* Required
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type
created	A string permitting tabs, carriage returns and newlines (Maximum length: 80)

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Cloud/Image/delete

Description:

Fires off a process to delete the requested image from the image server that stores it.

Parameters:

Parameter	Type	Notes
id	A positive integer value (i.e. 1 and up).	* Required

Returns:

Field	Type
deleted	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Cloud/Image/details

Description:

Get information about a specific image.

Here's a rundown of what those fields mean:

	accnt: your account number

	id: the id of the image

	features: an associate array of feature data that will be applied to any
	server created from this image

	name: the name you gave when you created the image

	size: the size of the image, in GB

	source_hostname: the hostname of the server from which this image was created

	source_uniq_id: the unique server identifier, made of 6 letters and numbers,
	of the server from which this image was created

	template: the name of the OS template image from which this image was created

	template_description: a more informative description of the OS of this image.
	'CentOS 5.5 64bit Core-Managed', for example.

	time_taken: the date and time at which the image was captured

Parameters:

Parameter	Type	Notes
id	A positive integer value (i.e. 1 and up).	* Required

Returns:

Field	Type	Notes
accnt	A valid account number, up to 6 digits in length.
features	An associative array of arbitrary keys and values.	* Optional
hv_type	A single word, consisting of only letters and digits.
id	A positive integer value (i.e. 1 and up).
name	A string permitting tabs, carriage returns and newlines (Maximum length: 80)
size	A positive floating-point value requiring a leading whole number.
source_hostname	A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_id	A six-character identifier, containing only capital letters and digits.	* Optional
template	A string.
template_description	A string.
time_taken	A valid date and time in YYYY-MM-DD HH:MM:SS format.

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Cloud/Image/list

Description:

Get a paginated list of previously-created images for your account. More information about the returned data structure can be found in the documentation for server/image/details

Parameters:

Parameter	Type	Notes
page_num	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 1
page_size	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 25

Returns:

Field	Type
item_count	A non-negative integer value (i.e. 0 and up).
item_total	A non-negative integer value (i.e. 0 and up).
items	An array of associative arrays containing
	accnt A valid account number, up to 6 digits in length. features An associative array of arbitrary keys and values. * Optional hv_type A single word, consisting of only letters and digits. id A positive integer value (i.e. 1 and up). name A string permitting tabs, carriage returns and newlines (Maximum length: 80) size A positive floating-point value requiring a leading whole number. source_hostname A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) source_uniq_id A six-character identifier, containing only capital letters and digits. * Optional template A string. template_description A string. time_taken A valid date and time in YYYY-MM-DD HH:MM:SS format.
page_num	A positive integer value (i.e. 1 and up).
page_size	A positive integer value (i.e. 1 and up).
page_total	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Cloud/Image/restore

Description:

Re-images a server with the image requested. If the 'force' flag is passed it will rebuild the filesystem on the server before restoring. This option is not usually needed, but if regular restores are failing, it can fix some scenarios.

Parameters:

Parameter	Type	Notes
force	A boolean value (0 or 1).
id	A positive integer value (i.e. 1 and up).	* Required
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type
reimaged	A six-character identifier, containing only capital letters and digits.

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Cloud/Image/update

Description:

Update an existing image. Currently, only renaming the image is supported. More information about the returned data structure can be found in the documentation for server/image/details/

Parameters:

Parameter	Type	Notes
id	A positive integer value (i.e. 1 and up).	* Required
name	A string permitting tabs, carriage returns and newlines (Maximum length: 80)	* Required

Returns:

Field	Type	Notes
accnt	A valid account number, up to 6 digits in length.
features	An associative array of arbitrary keys and values.	* Optional
hv_type	A single word, consisting of only letters and digits.
id	A positive integer value (i.e. 1 and up).
name	A string permitting tabs, carriage returns and newlines (Maximum length: 80)
size	A positive floating-point value requiring a leading whole number.
source_hostname	A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_id	A six-character identifier, containing only capital letters and digits.	* Optional
template	A string.
template_description	A string.
time_taken	A valid date and time in YYYY-MM-DD HH:MM:SS format.

Possible Errors:

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