Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
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:
Parameter | Type | Notes |
---|---|---|
uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
Field | Type | Notes |
---|---|---|
alternate_ssh_ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Optional |
alternate_ssh_port | A positive integer value (i.e. 1 and up). | * Optional |
login_username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Optional |
special_instructions | An arbitrary-length string | * Optional |
uniq_id | A six-character identifier, containing only capital letters and digits. | |
whm_access_key_valid | A 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:
Parameter | Type | Notes |
---|---|---|
alternate_ssh_ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
alternate_ssh_port | A valid network port number. | |
control_panel_password | A password, up to 63 characters in length | |
login_password | A password, up to 63 characters in length | |
login_username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | |
password | A password, up to 63 characters in length | |
special_instructions | A string permitting tabs, carriage returns and newlines | |
uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
whm_access_key | A string permitting tabs, carriage returns and newlines |
Returns:
Field | Type | Notes |
---|---|---|
alternate_ssh_ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Optional |
alternate_ssh_port | A positive integer value (i.e. 1 and up). | * Optional |
login_username | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Optional |
special_instructions | An arbitrary-length string | * Optional |
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