Overview
Error Handling

Methods

API Documentation (API Version bleed)

Cloud/Private/Parent/

DESCRIPTION

This section of the API provides convenience methods for managing Private Cloud Parents.

create

URL:

https://api.liquidweb.com/bleed/Cloud/Private/Parent/create

Description:

Reserver a new private parent for your account. This method takes

	config_id: the id of the server configuration you wish to use.  For a list
	of available configs, see the cloud/config/list API method.  For private
	parents, only bare-metal configs may be used.

	zone: The zone id you wish to reserve this parent in.  Only KVM zones
	are supported for private parents.

	domain:  All servers at liquidweb must have a domain, however for
	private parents this is only a user facing label.  As such it does
	not have to be a valid DNS name.

This method returns the same data as the details method.

Parameters:

ParameterTypeNotes
config_idA positive integer value (i.e. 1 and up).* Required
domainA string of text, containing no newlines or other control characters.* Required
zoneA positive integer value (i.e. 1 and up).

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
config_descriptionA string of text, containing no newlines or other control characters.
config_idA positive integer value (i.e. 1 and up).
create_dateA string of text, containing no newlines or other control characters.
domainA string of text, containing no newlines or other control characters.
idA positive integer value (i.e. 1 and up).
license_stateA single word, consisting of only letters, digits, and underscores.
region_idA positive integer value (i.e. 1 and up).
resourcesAn associative array containing the fields:
 
diskspaceAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
memoryAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
subaccntA positive integer value (i.e. 1 and up).
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
vcpuA positive integer value (i.e. 1 and up).
zoneAn associative array containing the fields:
 
availability_zoneA single word, consisting of only letters and digits.
descriptionA string permitting tabs, carriage returns and newlines
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines
regionAn associative array containing the fields:
 
idA positive integer value (i.e. 1 and up).
nameA string.
statusA single word, consisting of only letters and digits.
valid_source_hvsAn array of a single word, consisting of only letters and digits.

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Cloud/Private/Parent/delete

Description:

Removes a private parent from your account. This method will return an exception if your parent is not empty.

Parameters:

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

Returns:

FieldType
deletedA 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.liquidweb.com/bleed/Cloud/Private/Parent/details

Description:

Gets data relevant to a Private Cloud Parent.

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

	accnt: your account number

	active: a flag indicating whether the server has finished building

	config_id: the id of the server configuration this server is using

	region_id: the of the region that this parent is in.

	resourceState: A list of hashes, describing the current resources
	available on this parent.

	uniq_id: the unique server identifier, made of 6 letters and numbers

Parameters:

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

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
config_descriptionA string of text, containing no newlines or other control characters.
config_idA positive integer value (i.e. 1 and up).
create_dateA string of text, containing no newlines or other control characters.
domainA string of text, containing no newlines or other control characters.
idA positive integer value (i.e. 1 and up).
license_stateA single word, consisting of only letters, digits, and underscores.
region_idA positive integer value (i.e. 1 and up).
resourcesAn associative array containing the fields:
 
diskspaceAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
memoryAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
subaccntA positive integer value (i.e. 1 and up).
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
vcpuA positive integer value (i.e. 1 and up).
zoneAn associative array containing the fields:
 
availability_zoneA single word, consisting of only letters and digits.
descriptionA string permitting tabs, carriage returns and newlines
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines
regionAn associative array containing the fields:
 
idA positive integer value (i.e. 1 and up).
nameA string.
statusA single word, consisting of only letters and digits.
valid_source_hvsAn array of a single word, consisting of only letters and digits.

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Cloud/Private/Parent/list

Description:

Retrieve a paginated list of Private Cloud Parents on your account.

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
 
accntA valid account number, up to 6 digits in length.
config_descriptionA string of text, containing no newlines or other control characters.
config_idA positive integer value (i.e. 1 and up).
create_dateA string of text, containing no newlines or other control characters.
domainA string of text, containing no newlines or other control characters.
idA positive integer value (i.e. 1 and up).
license_stateA single word, consisting of only letters, digits, and underscores.
region_idA positive integer value (i.e. 1 and up).
resourcesAn associative array containing the fields:
 
diskspaceAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
memoryAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
subaccntA positive integer value (i.e. 1 and up).
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
vcpuA positive integer value (i.e. 1 and up).
zoneAn associative array containing the fields:
 
availability_zoneA single word, consisting of only letters and digits.
descriptionA string permitting tabs, carriage returns and newlines
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines
regionAn associative array containing the fields:
 
idA positive integer value (i.e. 1 and up).
nameA string.
statusA single word, consisting of only letters and digits.
valid_source_hvsAn array of a single word, consisting of only 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

update

URL:

https://api.liquidweb.com/bleed/Cloud/Private/Parent/update

Description:

Update details about your parent. Currently on the domain of the server can be updated.

Parameters:

ParameterTypeNotes
domainA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
config_descriptionA string of text, containing no newlines or other control characters.
config_idA positive integer value (i.e. 1 and up).
create_dateA string of text, containing no newlines or other control characters.
domainA string of text, containing no newlines or other control characters.
idA positive integer value (i.e. 1 and up).
license_stateA single word, consisting of only letters, digits, and underscores.
region_idA positive integer value (i.e. 1 and up).
resourcesAn associative array containing the fields:
 
diskspaceAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
memoryAn associative array containing the fields:
 
freeA non-negative integer value (i.e. 0 and up).
totalA positive integer value (i.e. 1 and up).
usedA non-negative integer value (i.e. 0 and up).
subaccntA positive integer value (i.e. 1 and up).
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
vcpuA positive integer value (i.e. 1 and up).
zoneAn associative array containing the fields:
 
availability_zoneA single word, consisting of only letters and digits.
descriptionA string permitting tabs, carriage returns and newlines
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines
regionAn associative array containing the fields:
 
idA positive integer value (i.e. 1 and up).
nameA string.
statusA single word, consisting of only letters and digits.
valid_source_hvsAn array of a single word, consisting of only letters and digits.

Possible Errors:

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