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)
Migration/
DESCRIPTION
This section contains methods for managing a migration.
A migration is defined as moving data from many source servers to one destination server. The source servers may be from another hosting company, or another LiquidWeb account. The destination server will always be a server on the account using this api.
The migration endpoint stores identification information for the 'from' account, references to the source servers, and triggers beginning the migration process.
create
URL:
https://api.liquidweb.com/bleed/Migration/create
Description:
Create a Migration.
Parameters:
| Parameter | Type |
|---|---|
| name | A string of text, containing no newlines or other control characters. |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
| id | A valid id number (a positive integer). | |
| name | A string of text, containing no newlines or other control characters. | * Optional |
| submitted_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| ticket_id | A positive integer value (i.e. 1 and up). | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delete
URL:
https://api.liquidweb.com/bleed/Migration/delete
Description:
Delete a Migration.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required |
Returns:
| Field | Type | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| deleted | An associative array containing the fields: | |||||||||||||||||||
| ||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Migration/details
Description:
Get details for a Migration.
Alsowith, allows a flat representation of all information in a migration as well.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'destination', 'hostingCompany', 'lastUpdated', 'migrationAccounts' | |
| id | A valid id number (a positive integer). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
| id | A valid id number (a positive integer). | |
| name | A string of text, containing no newlines or other control characters. | * Optional |
| submitted_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| ticket_id | A positive integer value (i.e. 1 and up). | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
detailsWithFullServers
URL:
https://api.liquidweb.com/bleed/Migration/detailsWithFullServers
Description:
Get full details for a Migration including the migration accounts, servers, server access credentials, database access credentials and the migration destination.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| destination | An associative array containing the fields: | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| migrationAccounts | An array of associative arrays containing | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| servers | An array of associative arrays containing | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| submitted_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ticket_id | A positive integer value (i.e. 1 and up). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
hostingCompanies
URL:
https://api.liquidweb.com/bleed/Migration/hostingCompanies
Description:
Get a list of available Hosting Companies and related information. When id is provided, the list of companies will be filtered to Hosting Companies on a Migration for that id.
Parameters:
| Parameter | Type |
|---|---|
| id | A valid id number (a positive integer). |
Returns:
| Field | Type | |||||
|---|---|---|---|---|---|---|
| company_list | An array of associative arrays containing | |||||
| ||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Migration/list
Description:
Get a list of Migrations.
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| alsowith | An array of One of: 'destination', 'hostingCompany', 'lastUpdated', 'migrationAccounts' | |||||||
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |||||||
| id | A valid id number (a positive integer). | |||||||
| order_by | An associative array containing the fields: | |||||||
| ||||||||
| page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| submitted | A boolean value (0 or 1). | |||||||
| ticket_id | Either: a positive integer value (i.e. 1 and up).; or a valid identifier for a Salesforce object | |||||||
Returns:
| Field | Type | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||
| items | An array of associative arrays containing | |||||||||||||||||||
| ||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||
| page_total | A positive integer value (i.e. 1 and up). | |||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
oneClick
URL:
https://api.liquidweb.com/bleed/Migration/oneClick
Description:
Start a one click migration for a given uniq_id to a provided destination ip
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| ip | A valid IP address (v4 or v6) IP address of the destination parent | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| success | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
submit
URL:
https://api.liquidweb.com/bleed/Migration/submit
Description:
Submit a Migration for processing. Once submitted, a Support Request ticket will be created to start the Migration process.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required |
| notes | A string permitting tabs, carriage returns and newlines |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
| id | A valid id number (a positive integer). | |
| name | A string of text, containing no newlines or other control characters. | * Optional |
| submitted_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| ticket_id | A positive integer value (i.e. 1 and up). | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/bleed/Migration/update
Description:
Update a Migration.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required |
| name | A string of text, containing no newlines or other control characters. |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | |
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
| id | A valid id number (a positive integer). | |
| name | A string of text, containing no newlines or other control characters. | * Optional |
| submitted_date | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| ticket_id | A positive integer value (i.e. 1 and up). | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
validate
URL:
https://api.liquidweb.com/bleed/Migration/validate
Description:
Valdiate an existing migration. Invalid migrations will throw an exception. Can be invalid for updating, if the migration is already submitted, or invalid for submitting, if the migration is not complete enough.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required |
| restrict | A boolean value (0 or 1). |
Returns:
| Field | Type |
|---|---|
| validated | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
