Overview
Error Handling

Methods

API Documentation (API Version v1)

VIP/

DESCRIPTION

This section contains methods to manage the Virtual IP services of a particular account.

create

URL:

https://api.stormondemand.com/v1/VIP/create

Description:

create a new Virtual IP service.

Parameters:

ParameterTypeNotes
domainA string of text, containing no newlines or other control characters.* Required
zoneAn integer value.* Required

Returns:

FieldType
activeA boolean value (0 or 1).
activeStatusA single word, consisting of only letters and digits.
domainA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.
zoneA positive integer value (i.e. 1 and up).

Possible Errors:

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

destroy

URL:

https://api.stormondemand.com/v1/VIP/destroy

Description:

remove a Virtual IP service.

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

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

Possible Errors:

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

details

URL:

https://api.stormondemand.com/v1/VIP/details

Description:

Get information about the VIP subaccnt.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
activeA boolean value (0 or 1).
activeStatusA single word, consisting of only letters and digits.
domainA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.
zoneA positive integer value (i.e. 1 and up).

Possible Errors:

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