URL:

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

Description:

Attach a volume to a particular instance.

Parameters:

Parameter	Type	Notes
to	A six-character identifier, containing only capital letters and digits.	* Required
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type
attached	A six-character identifier, containing only capital letters and digits.
to	A six-character identifier, containing only capital letters and digits.

Possible Errors:

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

URL:

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

Description:

Create a new volume.

Parameters:

Parameter	Type	Notes
attach	A six-character identifier, containing only capital letters and digits.
cross_attach	A boolean value (0 or 1).
domain	A string of text, containing no newlines or other control characters.	* Required
region	A positive integer value (i.e. 1 and up).
size	A positive integer value (i.e. 1 and up).	* Required
zone	A positive integer value (i.e. 1 and up).

Returns:

Field	Type	Notes
attachedTo	An array of associative arrays containing
	device A string of text, containing no newlines or other control characters. resource A six-character identifier, containing only capital letters and digits.
cross_attach	A boolean value (0 or 1).
domain	A string of text, containing no newlines or other control characters.
label	A string permitting tabs, carriage returns and newlines	* Optional
size	A positive integer value (i.e. 1 and up).
status	A single word, consisting of only letters, digits, hyphens, and underscores.
uniq_id	A six-character identifier, containing only capital letters and digits.
zoneAvailability	An 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

URL:

https://api.liquidweb.com/v1/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:

Parameter	Type	Notes
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type
deleted	A six-character identifier, containing only capital letters and digits.

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/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:

Parameter	Type	Notes
detach_from	A six-character identifier, containing only capital letters and digits.
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type	Notes
detached	A six-character identifier, containing only capital letters and digits.
detached_from	A six-character identifier, containing only capital letters and digits.	* Optional

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/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:

Parameter	Type	Notes
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type	Notes
attachedTo	An array of associative arrays containing
	device A string of text, containing no newlines or other control characters. resource A six-character identifier, containing only capital letters and digits.
cross_attach	A boolean value (0 or 1).
domain	A string of text, containing no newlines or other control characters.
label	A string permitting tabs, carriage returns and newlines	* Optional
size	A positive integer value (i.e. 1 and up).
status	A single word, consisting of only letters, digits, hyphens, and underscores.
uniq_id	A six-character identifier, containing only capital letters and digits.
zoneAvailability	An 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

URL:

https://api.liquidweb.com/v1/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:

Parameter	Type	Notes
attached_to	A six-character identifier, containing only capital letters and digits.
page_num	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 1
page_size	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 25

Returns:

Field	Type
item_count	A non-negative integer value (i.e. 0 and up).
item_total	A non-negative integer value (i.e. 0 and up).
items	An array of associative arrays containing
	attachedTo An array of associative arrays containing   device A string of text, containing no newlines or other control characters. resource A six-character identifier, containing only capital letters and digits. cross_attach A boolean value (0 or 1). domain A string of text, containing no newlines or other control characters. label A string permitting tabs, carriage returns and newlines * Optional size A positive integer value (i.e. 1 and up). status A single word, consisting of only letters, digits, hyphens, and underscores. uniq_id A six-character identifier, containing only capital letters and digits. zoneAvailability An array of a positive integer value (i.e. 1 and up).
page_num	A positive integer value (i.e. 1 and up).
page_size	A positive integer value (i.e. 1 and up).
page_total	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

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

Description:

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

Parameters:

Parameter	Type	Notes
new_size	A positive integer value (i.e. 1 and up).	* Required
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type
new_size	A positive integer value (i.e. 1 and up).
old_size	A positive integer value (i.e. 1 and up).
uniq_id	A six-character identifier, containing only capital letters and digits.

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/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:

Parameter	Type	Notes
cross_attach	A boolean value (0 or 1).
domain	A string of text, containing no newlines or other control characters.
uniq_id	A six-character identifier, containing only capital letters and digits.	* Required

Returns:

Field	Type	Notes
attachedTo	An array of associative arrays containing
	device A string of text, containing no newlines or other control characters. resource A six-character identifier, containing only capital letters and digits.
cross_attach	A boolean value (0 or 1).
domain	A string of text, containing no newlines or other control characters.
label	A string permitting tabs, carriage returns and newlines	* Optional
size	A positive integer value (i.e. 1 and up).
status	A single word, consisting of only letters, digits, hyphens, and underscores.
uniq_id	A six-character identifier, containing only capital letters and digits.
zoneAvailability	An 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