Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/Zone/

DESCRIPTION

A zone is a high level chunk of infrastructure. This class provides methods for listing zones.

details

URL:

https://api.stormondemand.com/v1/Network/Zone/details

Description:

Returns details of a given network zone by its name or id field.

Parameters:

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

Returns:

FieldType
idA positive integer value (i.e. 1 and up).
is_defaultA boolean value (0 or 1).
nameA string.
regionAn associative array containing the values:
 
idA positive integer value (i.e. 1 and up).
nameA string.
statusA single word, consisting of only letters and digits.
valid_source_hvsAn associative array containing the values:
 
kvmA boolean value (0 or 1).* Optional
xenA boolean value (0 or 1).* Optional

Possible Errors:

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

list

URL:

https://api.stormondemand.com/v1/Network/Zone/list

Description:

Returns a list of zones.

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
regionA string permitting tabs, carriage returns and newlines

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
 
idA positive integer value (i.e. 1 and up).
is_defaultA boolean value (0 or 1).
nameA string.
regionAn associative array containing the values:
 
idA positive integer value (i.e. 1 and up).
nameA string.
statusA single word, consisting of only letters and digits.
valid_source_hvsAn associative array containing the values:
 
kvmA boolean value (0 or 1).* Optional
xenA boolean value (0 or 1).* Optional
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

setDefault

URL:

https://api.stormondemand.com/v1/Network/Zone/setDefault

Description:

Sets the default zone for an account.

Parameters:

ParameterTypeNotes
idA non-negative integer value (i.e. 0 and up).* Required

Returns:

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

Possible Errors:

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