hello,
Home Page
Overview
Error Handling
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/Region/
- 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)
WordPress/Domain/
DESCRIPTION
This section contains methods for managed WordPress.
backups
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/backups
Description:
Retrieve a backup list for a WordPress domain.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| backups | An array of associative arrays containing | |||||||||
| ||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
create
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/create
Description:
Create a new WordPress domain.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | * Required |
| A valid email address. | * Required | |
| features | An associative array of arbitrary keys and values. | |
| parent_uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
| password | A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation. | * Required |
| username | A username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| A valid email address. | ||
| features | An associative array of arbitrary keys and values. | * Optional |
| parent_uniq_id | A six-character identifier, containing only capital letters and digits. | |
| password | A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation. | |
| username | A username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
createStagingSite
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/createStagingSite
Description:
Create a staging site that is a copy of the existing site
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
| domain_uniq_id | A six-character identifier, containing only capital letters and digits. |
| password | A string permitting tabs, carriage returns and newlines |
| username | A string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delete
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/delete
Description:
Delete a new WordPress domain.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| deleted | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
installSignedSSL
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/installSignedSSL
Description:
Attempt the install of a signed SSL for the WordPress Domain
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | Notes |
|---|---|---|
| pending | A boolean value (0 or 1). | * Optional |
| pending_since | Either: a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.; or a valid SQL time command, e.g. now() | * Optional |
| ssl_type | One of: 'none', 'self-signed', 'signed' | * Optional |
| ssl_uniq_id | A six-character identifier, containing only capital letters and digits. | * 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
list
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/list
Description:
List domains for the subaccount.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| A valid email address. | ||
| features | An associative array of arbitrary keys and values. | * Optional |
| parent_uniq_id | A six-character identifier, containing only capital letters and digits. | |
| password | A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation. | |
| username | A username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
removeStagingSite
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/removeStagingSite
Description:
Create a staging site that is a copy of the existing site
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| removed | A boolean value (0 or 1). |
| 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
restore
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/restore
Description:
Restores a backup for a WordPress domain.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| filename | A string of text, containing no newlines or other control characters. | * Required |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| restoring | A string of text, containing no newlines or other control characters. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/bleed/WordPress/Domain/update
Description:
Create a new WordPress domain.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| features | An associative array of arbitrary keys and values. | |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters. | |
| A valid email address. | ||
| features | An associative array of arbitrary keys and values. | * Optional |
| parent_uniq_id | A six-character identifier, containing only capital letters and digits. | |
| password | A password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation. | |
| username | A username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
