Overview
Error Handling

Methods

API Documentation (API Version v1)

Storm/Config/

DESCRIPTION

The list of available Storm server configurations is found here.

details

URL:

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

Description:

Get information about a specific config.

Here's a rundown of what those fields mean:

	active: a flag indicating whether this server configuration is currently active

	available: a flag indicating whether any machines are available for this
	server configuration

	description: a description of the configuration type. 'Storm 2GB', for example.

	disk: the amount of available disk space, in GB

	featured: some configurations are flagged as 'featured' so we show them on
	the Storm home page.  This flag is devoid of any meaning otherwise.

	id: the id of this server configuration.  Use this values as the 'config_id'
	in storm/server/create and storm/server/resize

	memory: the amount of available RAM, in MB

	price: a data structure giving the hourly price and estimated monthly price
	of this configuration

	zone_availability: a data structure giving the availability of this config
	for in various zones.

	vcpu: the number of CPUs available to this configuration

Parameters:

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

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
availableA non-negative integer value (i.e. 0 and up).
categoryA string.
cpu_coresA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_countA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_hyperthreadingA boolean value (0 or 1).* Required if:
  • category is set to 'bare-metal'
cpu_modelA string.* Required if:
  • category is set to 'bare-metal'
cpu_speedA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
descriptionA string.
diskA positive integer value (i.e. 1 and up).* Optional
disk_countA non-negative integer value (i.e. 0 and up).* Required if:
  • category is set to 'bare-metal'
disk_totalA non-negative integer value (i.e. 0 and up).* Required if:
  • category is set to 'bare-metal'
disk_typeA string permitting tabs, carriage returns and newlines* Required if:
  • category is set to 'bare-metal'
featuredA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).
memoryA positive integer value (i.e. 1 and up).* Optional
raid_levelAn integer value.* Required if:
  • category is set to 'bare-metal'
ram_availableA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
ram_totalA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
vcpuA positive integer value (i.e. 1 and up).* Optional
zone_availabilityAn associative array of arbitrary keys and values.

Possible Errors:

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

list

URL:

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

Description:

Get a list of available server configurations. Only active configurations will be returned by this method, whereas the 'details' method will allow you to query information about an inactive configuration. For more information about the fields returned here, refer to the documentation for storm/config/details.

valid options for category are storm, ssd, bare-metal and all.

Parameters:

ParameterTypeNotes
availableA boolean value (0 or 1).
categoryA single word, consisting of only letters, digits, hyphens, and underscores.* Optional
  • Defaults to: storm
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
 
activeA boolean value (0 or 1).
availableA non-negative integer value (i.e. 0 and up).
categoryA string.
cpu_coresA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_countA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
cpu_hyperthreadingA boolean value (0 or 1).* Required if:
  • category is set to 'bare-metal'
cpu_modelA string.* Required if:
  • category is set to 'bare-metal'
cpu_speedA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
descriptionA string.
diskA positive integer value (i.e. 1 and up).* Optional
disk_countA non-negative integer value (i.e. 0 and up).* Required if:
  • category is set to 'bare-metal'
disk_totalA non-negative integer value (i.e. 0 and up).* Required if:
  • category is set to 'bare-metal'
disk_typeA string permitting tabs, carriage returns and newlines* Required if:
  • category is set to 'bare-metal'
featuredA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).
memoryA positive integer value (i.e. 1 and up).* Optional
raid_levelAn integer value.* Required if:
  • category is set to 'bare-metal'
ram_availableA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
ram_totalA positive integer value (i.e. 1 and up).* Required if:
  • category is set to 'bare-metal'
vcpuA positive integer value (i.e. 1 and up).* Optional
zone_availabilityAn associative array of arbitrary keys and values.
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