Overview
Error Handling

Methods

API Documentation (API Version bleed)

Storage/Block/Volume/

DESCRIPTION

Block storage offers a method to attach additional storage to server instances. Once attached, volumes appear as normal block devices, and can be used as such.

attach

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/attach

Description:

Attach a volume to a particular instance.

Parameters:

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

Returns:

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

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/create

Description:

Create a new volume.

Parameters:

ParameterTypeNotes
attachA six-character identifier, containing only capital letters and digits.
cross_attachA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.* Required
regionA positive integer value (i.e. 1 and up).
sizeA positive integer value (i.e. 1 and up).* Required
zoneA positive integer value (i.e. 1 and up).

Returns:

FieldTypeNotes
attachedToAn array of associative arrays containing
 
deviceA string of text, containing no newlines or other control characters.
resourceA six-character identifier, containing only capital letters and digits.
cross_attachA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.
labelA string permitting tabs, carriage returns and newlines* Optional
sizeA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters, digits, hyphens, and underscores.
uniq_idA six-character identifier, containing only capital letters and digits.
zoneAvailabilityAn array of a positive integer value (i.e. 1 and up).

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/delete

Description:

Delete a volume, including any and all data stored on it. The volume must not be attached to any instances to call this method.

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

detach

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/detach

Description:

Detach a volume from an instance. This method is roughly equivalent to unplugging an external drive, and it is important to ensure the volume is unmounted before using this method.

Parameters:

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

Returns:

FieldTypeNotes
detachedA six-character identifier, containing only capital letters and digits.
detached_fromA six-character identifier, containing only capital letters and digits.* Optional

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/details

Description:

Retrieve information about a specific volume.

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

	accnt: your account number

	id: the id of the volume

	domain: the name you gave the volume on creation

	size: the size of the volume, in GB

	status: status of the volume (unprovisioned, active, or attached)

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

	attached_to: the unique identifier of the server this volume
		     is attached to (or 'null').

	device: if the volume is attached to a server,
		this is the device that it is attached as.

Parameters:

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

Returns:

FieldTypeNotes
attachedToAn array of associative arrays containing
 
deviceA string of text, containing no newlines or other control characters.
resourceA six-character identifier, containing only capital letters and digits.
cross_attachA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.
labelA string permitting tabs, carriage returns and newlines* Optional
sizeA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters, digits, hyphens, and underscores.
uniq_idA six-character identifier, containing only capital letters and digits.
zoneAvailabilityAn array of a positive integer value (i.e. 1 and up).

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/list

Description:

Get a paginated list of block storage volumes for your account. More information about the returned data structure can be found in the documentation for storage/block/volume/details

Parameters:

ParameterTypeNotes
attached_toA six-character identifier, containing only capital letters and digits.
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
 
attachedToAn array of associative arrays containing
 
deviceA string of text, containing no newlines or other control characters.
resourceA six-character identifier, containing only capital letters and digits.
cross_attachA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.
labelA string permitting tabs, carriage returns and newlines* Optional
sizeA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters, digits, hyphens, and underscores.
uniq_idA six-character identifier, containing only capital letters and digits.
zoneAvailabilityAn array of a positive integer value (i.e. 1 and up).
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

resize

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/resize

Description:

Resize a volume. Volumes can currently only be resized larger.

Parameters:

ParameterTypeNotes
new_sizeA positive integer value (i.e. 1 and up).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
new_sizeA positive integer value (i.e. 1 and up).
old_sizeA positive integer value (i.e. 1 and up).
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

update

URL:

https://api.liquidweb.com/bleed/Storage/Block/Volume/update

Description:

Update an existing volume. Currently, only renaming the volume is supported. More information about the returned data structure can be found in the documentation for storage/block/volume/details/

Parameters:

ParameterTypeNotes
cross_attachA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
attachedToAn array of associative arrays containing
 
deviceA string of text, containing no newlines or other control characters.
resourceA six-character identifier, containing only capital letters and digits.
cross_attachA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.
labelA string permitting tabs, carriage returns and newlines* Optional
sizeA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters, digits, hyphens, and underscores.
uniq_idA six-character identifier, containing only capital letters and digits.
zoneAvailabilityAn array of a positive integer value (i.e. 1 and up).

Possible Errors:

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