Overview
Error Handling

Methods

API Documentation (API Version v1)

Storm/Image/

DESCRIPTION

Customer can create images of their server's hard drive on-demand. This section of the API allows remote interaction with those images.

create

URL:

https://api.stormondemand.com/v1/Storm/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:

ParameterTypeNotes
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
createdA string permitting tabs, carriage returns and newlines (Maximum length: 80)

Possible Errors:

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

delete

URL:

https://api.stormondemand.com/v1/Storm/Image/delete

Description:

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

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
deletedA positive integer value (i.e. 1 and up).

Possible Errors:

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

details

URL:

https://api.stormondemand.com/v1/Storm/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:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
featuresAn associative array of arbitrary keys and values.* Optional
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA 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

list

URL:

https://api.stormondemand.com/v1/Storm/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:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accntA valid account number, up to 6 digits in length.
featuresAn associative array of arbitrary keys and values.* Optional
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

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

restore

URL:

https://api.stormondemand.com/v1/Storm/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:

ParameterTypeNotes
forceA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
reimagedA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

update

URL:

https://api.stormondemand.com/v1/Storm/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:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
featuresAn associative array of arbitrary keys and values.* Optional
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA 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