Overview
Error Handling

Methods

API Documentation (API Version bleed)

Storage/ObjectStore/

DESCRIPTION

This section contains methods to manage the object store.

create

URL:

https://api.liquidweb.com/bleed/Storage/ObjectStore/create

Description:

create a new object store.

Parameters:

No Values Defined

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
capsAn array of associative arrays containing
 
permA string.
typeA string.
display_nameA string.
hostA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)
keysAn array of associative arrays containing
 
access_keyA string.
secret_keyA string.
userA string.
max_bucketsA positive integer value (i.e. 1 and up).
suspendedA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.
user_idA string.

Possible Errors:

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

createKey

URL:

https://api.liquidweb.com/bleed/Storage/ObjectStore/createKey

Description:

Create a new key for a specific Rados Gateway user

Parameters:

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

Returns:

FieldType
access_keyA string.
secret_keyA string.
userA string.

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Storage/ObjectStore/delete

Description:

Delete an object store.

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

deleteKey

URL:

https://api.liquidweb.com/bleed/Storage/ObjectStore/deleteKey

Description:

Delete an existing key for a specific Rados Gateway user

Parameters:

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

Returns:

FieldType
deletedA string.

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Storage/ObjectStore/details

Description:

Get information about an object store.

Parameters:

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

Returns:

FieldType
capsAn array of associative arrays containing
 
permA string.
typeA string.
display_nameA string.
hostA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)
keysAn array of associative arrays containing
 
access_keyA string.
secret_keyA string.
userA string.
max_bucketsA positive integer value (i.e. 1 and up).
suspendedA boolean value (0 or 1).
user_idA string.

Possible Errors:

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

diskSpace

URL:

https://api.liquidweb.com/bleed/Storage/ObjectStore/diskSpace

Description:

Parameters:

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

Returns:

FieldType
bucketsAn associative array of arbitrary keys and values.
totalA non-negative integer value (i.e. 0 and up).

Possible Errors:

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