Overview
Error Handling

Methods

API Documentation (API Version v1)

Server/VirtualDomain/

DESCRIPTION

API methods for interacting with add-on domains for shared servers.

create

URL:

https://api.stormondemand.com/v1/Server/VirtualDomain/create

Description:

Create a new add-on domain for a shared subaccnt.

Parameters:

ParameterTypeNotes
domainA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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

freeCount

URL:

https://api.stormondemand.com/v1/Server/VirtualDomain/freeCount

Description:

Returns a large number of free VIRs for any account type Keeping for backward compatibility of v1

Parameters:

ParameterTypeNotes
typeA valid product code, at least 3 chars long, including at least one letter.* Required

Returns:

FieldType
countA positive integer value (i.e. 1 and up).
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.

Possible Errors:

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

list

URL:

https://api.stormondemand.com/v1/Server/VirtualDomain/list

Description:

Lists the domains for a given server.

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.* Required

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).
activeStatusA single word, consisting of only letters, digits, hyphens, and underscores.
customA string permitting tabs, carriage returns and newlines* Optional
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
managedTypeA single word, consisting of only letters and digits.* Optional
region_idA positive integer value (i.e. 1 and up).
serverA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
usernameA subaccnt username consisting of up to 20 characters (letters, numbers, hyphens, periods and underscores).* 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

listOrphans

URL:

https://api.stormondemand.com/v1/Server/VirtualDomain/listOrphans

Description:

Lists the domains in an account that are not linked to a server.

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
 
activeA boolean value (0 or 1).
activeStatusA single word, consisting of only letters, digits, hyphens, and underscores.
customA string permitting tabs, carriage returns and newlines* Optional
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
managedTypeA single word, consisting of only letters and digits.* Optional
region_idA positive integer value (i.e. 1 and up).
serverA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
usernameA subaccnt username consisting of up to 20 characters (letters, numbers, hyphens, periods and underscores).* 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

relink

URL:

https://api.stormondemand.com/v1/Server/VirtualDomain/relink

Description:

Links an existing orphaned add-on domain to a shared subaccnt.

Parameters:

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

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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