Overview
Error Handling

Methods

API Documentation (API Version bleed)

Server/Auth/

DESCRIPTION

This sections provide methods for liquidweb's stored auth. On managed servers, we may need to log into the machine from time to time. We use the authentication information stored with these methods to do so.

details

URL:

https://api.liquidweb.com/bleed/Server/Auth/details

Description:

Returns the stored auth information for a server. This method does not return either the main or alternate password.

Parameters:

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

Returns:

FieldTypeNotes
alternate_ssh_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
alternate_ssh_portA positive integer value (i.e. 1 and up).* Optional
login_usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
special_instructionsAn arbitrary-length string* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
whm_access_key_validA boolean value (0 or 1).* Optional

Possible Errors:

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

update

URL:

https://api.liquidweb.com/bleed/Server/Auth/update

Description:

Updates the stored authentication information for a server. Any of these fields can be blanked by setting the field to an empty string ('').

Parameters:

ParameterTypeNotes
alternate_ssh_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
alternate_ssh_portA valid network port number.
control_panel_passwordA password, up to 63 characters in length
login_passwordA password, up to 63 characters in length
login_usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).
passwordA password, up to 63 characters in length
special_instructionsA string permitting tabs, carriage returns and newlines
uniq_idA six-character identifier, containing only capital letters and digits.* Required
whm_access_keyA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
alternate_ssh_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
alternate_ssh_portA positive integer value (i.e. 1 and up).* Optional
login_usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
special_instructionsAn arbitrary-length string* Optional
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