Overview
Error Handling

Methods

API Documentation (API Version bleed)

Asset/ControlPanel/Credentials/

check

URL:

https://api.liquidweb.com/bleed/Asset/ControlPanel/Credentials/check

Description:

Parameters:

ParameterTypeNotes
auth_typeA single word, consisting of only letters, digits, hyphens, and underscores.* Required
control_panelA single word, consisting of only letters, digits, hyphens, and underscores.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required
usernameA string permitting tabs, carriage returns and newlines

Returns:

FieldType
validA boolean value (0 or 1).

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/Asset/ControlPanel/Credentials/create

Description:

Parameters:

ParameterTypeNotes
auth_typeA single word, consisting of only letters, digits, hyphens, and underscores.* Required
control_panelA single word, consisting of only letters, digits, hyphens, and underscores.* Required
credentialsA string permitting tabs, carriage returns and newlines* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required
usernameA string permitting tabs, carriage returns and newlines
validA boolean value (0 or 1).

Returns:

FieldTypeNotes
auth_typeOne of: 'access_hash', 'api_token', 'password'
control_panelOne of: 'interworx', 'plesk', 'whm'
idA valid id number (a positive integer).
uniq_idA six-character identifier, containing only capital letters and digits.
usernameA string permitting tabs, carriage returns and newlines* Optional
validA boolean value (0 or 1).

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Asset/ControlPanel/Credentials/delete

Description:

Parameters:

ParameterTypeNotes
auth_typeA single word, consisting of only letters, digits, hyphens, and underscores.* Required
control_panelA single word, consisting of only letters, digits, hyphens, and underscores.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
deletedA boolean value (0 or 1).

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Asset/ControlPanel/Credentials/list

Description:

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
auth_typeA single word, consisting of only letters, digits, hyphens, and underscores.
control_panelA single word, consisting of only letters, digits, hyphens, and underscores.
order_byAn associative array containing the fields:
 
fieldOne of: 'control_panel', 'type'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
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
subaccnt_typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idAn array of a six-character identifier, containing only capital letters and digits.
validA boolean value (0 or 1).

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
 
auth_typeOne of: 'access_hash', 'api_token', 'password'
control_panelOne of: 'interworx', 'plesk', 'whm'
idA valid id number (a positive integer).
uniq_idA six-character identifier, containing only capital letters and digits.
usernameA string permitting tabs, carriage returns and newlines* Optional
validA boolean value (0 or 1).
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

set

URL:

https://api.liquidweb.com/bleed/Asset/ControlPanel/Credentials/set

Description:

Parameters:

ParameterTypeNotes
auth_typeA single word, consisting of only letters, digits, hyphens, and underscores.* Required
control_panelA single word, consisting of only letters, digits, hyphens, and underscores.* Required
credentialsA string permitting tabs, carriage returns and newlines
uniq_idA six-character identifier, containing only capital letters and digits.* Required
usernameA string permitting tabs, carriage returns and newlines
validA boolean value (0 or 1).

Returns:

FieldTypeNotes
auth_typeOne of: 'access_hash', 'api_token', 'password'
control_panelOne of: 'interworx', 'plesk', 'whm'
idA valid id number (a positive integer).
uniq_idA six-character identifier, containing only capital letters and digits.
usernameA string permitting tabs, carriage returns and newlines* Optional
validA boolean value (0 or 1).

Possible Errors:

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

update

URL:

https://api.liquidweb.com/bleed/Asset/ControlPanel/Credentials/update

Description:

Parameters:

ParameterTypeNotes
auth_typeA single word, consisting of only letters, digits, hyphens, and underscores.* Required
control_panelA single word, consisting of only letters, digits, hyphens, and underscores.* Required
credentialsA string permitting tabs, carriage returns and newlines
uniq_idA six-character identifier, containing only capital letters and digits.* Required
usernameA string permitting tabs, carriage returns and newlines
validA boolean value (0 or 1).

Returns:

FieldTypeNotes
auth_typeOne of: 'access_hash', 'api_token', 'password'
control_panelOne of: 'interworx', 'plesk', 'whm'
idA valid id number (a positive integer).
uniq_idA six-character identifier, containing only capital letters and digits.
usernameA string permitting tabs, carriage returns and newlines* Optional
validA boolean value (0 or 1).

Possible Errors:

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