Overview
Error Handling

Methods

API Documentation (API Version bleed)

Server/WHM/AccessHash/

DESCRIPTION

Through these api methods, you can manage WHM access hashes.

create

URL:

https://api.liquidweb.com/bleed/Server/WHM/AccessHash/create

Description:

Parameters:

ParameterTypeNotes
hashA valid WHM access hash, consisting of a hexadecimal number possibly split over multiple lines.* Required
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
uniq_idA six-character identifier, containing only capital letters and digits.
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/Server/WHM/AccessHash/delete

Description:

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
deletedA boolean value (0 or 1).

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Server/WHM/AccessHash/details

Description:

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
uniq_idA six-character identifier, containing only capital letters and digits.
validA 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/Server/WHM/AccessHash/list

Description:

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
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
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
uniq_idA six-character identifier, containing only capital letters and digits.
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

update

URL:

https://api.liquidweb.com/bleed/Server/WHM/AccessHash/update

Description:

Parameters:

ParameterTypeNotes
hashA valid WHM access hash, consisting of a hexadecimal number possibly split over multiple lines.* Required if:
  • valid is not given
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.
validA boolean value (0 or 1).* Required if:
  • hash is not given

Returns:

FieldType
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
uniq_idA six-character identifier, containing only capital letters and digits.
validA boolean value (0 or 1).

Possible Errors:

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