Overview
Error Handling

Methods

API Documentation (API Version v1)

Storm/Backup/

DESCRIPTION

For customers with a backup plan, their servers are backed up daily. This section of the api allows remote interaction with those backups.

details

URL:

https://api.stormondemand.com/v1/Storm/Backup/details

Description:

Get information about a specific backup.

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

	accnt: your account number

	id: the id of the backup

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

	name: a displayable backup name

	size: the size of the backup, in GB

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

	time_taken: the date and time at which the backup was created

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

Parameters:

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

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.
sizeA positive floating-point value.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

list

URL:

https://api.stormondemand.com/v1/Storm/Backup/list

Description:

Get a paginated list of backups for a particular server. More information about the data returned can be found under the documentation for storm/backup/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
uniq_idA six-character identifier, containing only capital letters and digits.

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.
sizeA positive floating-point value.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
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/Backup/restore

Description:

Re-images a server with the backup 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
restoredA six-character identifier, containing only capital letters and digits.

Possible Errors:

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