Overview
Error Handling

Methods

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:

ParameterType
nameA string of text, containing no newlines or other control characters.

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA 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:

ParameterTypeNotes
idA valid id number (a positive integer).* Required

Returns:

FieldType
deletedAn associative array containing the fields:
 
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA positive integer value (i.e. 1 and up).* Optional

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:

ParameterTypeNotes
alsowithAn array of One of: 'destination', 'hostingCompany', 'lastUpdated', 'migrationAccounts'
idA valid id number (a positive integer).* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA 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:

ParameterTypeNotes
idA valid id number (a positive integer).* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
destinationAn associative array containing the fields:* Optional
 
apache_versionA string of text, containing no newlines or other control characters.* Optional
change_name_serverA string of text, containing no newlines or other control characters.* Optional
cpanel_backupA boolean value (0 or 1).* Optional
csf_from_server_idA valid id number (a positive integer).* Optional
idA valid id number (a positive integer).
migration_idA valid id number (a positive integer).
name_serverA string of text, containing no newlines or other control characters.* Optional
name_server_backupA string of text, containing no newlines or other control characters.* Optional
notesA string permitting tabs, carriage returns and newlines* Optional
php_versionA string of text, containing no newlines or other control characters.* Optional
required_softwareA string permitting tabs, carriage returns and newlines* Optional
software_from_server_idA valid id number (a positive integer).* Optional
target_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
test_domainsA string permitting tabs, carriage returns and newlines* Optional
idA valid id number (a positive integer).
migrationAccountsAn array of associative arrays containing * Optional
 
current_lw_accountA boolean value (0 or 1).* Optional
hosting_companyA string of text, containing no newlines or other control characters.
idA valid id number (a positive integer).
migration_idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
passwordEither: a boolean value (0 or 1).; or a string permitting tabs, carriage returns and newlines* Optional
touched_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
usernameA string of text, containing no newlines or other control characters.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
serversAn array of associative arrays containing * Optional
 
account_idA valid id number (a positive integer).
backup_detailsA string permitting tabs, carriage returns and newlines* Optional
backup_locationA string of text, containing no newlines or other control characters.* Optional
cron_jobsA string permitting tabs, carriage returns and newlines* Optional
databaseAccessesAn array of associative arrays containing * Optional
 
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
db_nameA string of text, containing no newlines or other control characters.* Optional
explainA string permitting tabs, carriage returns and newlines* Optional
idA valid id number (a positive integer).
portA positive integer value (i.e. 1 and up).* Optional
resellerA boolean value (0 or 1).
secretEither: a boolean value (0 or 1).; or a string permitting tabs, carriage returns and newlines* Optional
server_idA valid id number (a positive integer).
touched_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
typeA string of text, containing no newlines or other control characters.
urlA string of text, containing no newlines or other control characters.* Optional
usernameA string of text, containing no newlines or other control characters.* Optional
databasesA string permitting tabs, carriage returns and newlines* Optional
domainA string of text, containing no newlines or other control characters.* Optional
email_detailsA string permitting tabs, carriage returns and newlines* Optional
hostnameA string of text, containing no newlines or other control characters.* Optional
idA valid id number (a positive integer).
ipA valid IP address (v4 or v6)* Optional
notesA string permitting tabs, carriage returns and newlines* Optional
platformA string of text, containing no newlines or other control characters.* Optional
serverAccessAn associative array containing the fields:* Optional
 
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
db_nameA string of text, containing no newlines or other control characters.* Optional
explainA string permitting tabs, carriage returns and newlines* Optional
idA valid id number (a positive integer).
portA positive integer value (i.e. 1 and up).* Optional
resellerA boolean value (0 or 1).
secretEither: a boolean value (0 or 1).; or a string permitting tabs, carriage returns and newlines* Optional
server_idA valid id number (a positive integer).
touched_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
typeA string of text, containing no newlines or other control characters.
urlA string of text, containing no newlines or other control characters.* Optional
usernameA string of text, containing no newlines or other control characters.* Optional
touched_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
transfer_contentA string permitting tabs, carriage returns and newlines* Optional
transfer_typeA string of text, containing no newlines or other control characters.* Optional
typeA string of text, containing no newlines or other control characters.* Optional
usernameA string permitting tabs, carriage returns and newlines* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA 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:

ParameterType
idA valid id number (a positive integer).

Returns:

FieldType
company_listAn array of associative arrays containing
 
hosting_companyA string permitting tabs, carriage returns and newlines
templateA string permitting tabs, carriage returns and newlines

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:

ParameterTypeNotes
alsowithAn array of One of: 'destination', 'hostingCompany', 'lastUpdated', 'migrationAccounts'
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
order_byAn associative array containing the fields:
 
fieldOne of: 'accnt', 'created_date', 'id', 'submitted_date'* Optional
  • Defaults to: created_date
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
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
submittedA boolean value (0 or 1).
ticket_idEither: a positive integer value (i.e. 1 and up).; or a valid identifier for a Salesforce object

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
 
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA positive integer value (i.e. 1 and up).* Optional
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

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:

ParameterTypeNotes
idA valid id number (a positive integer).* Required
notesA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA 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:

ParameterTypeNotes
idA valid id number (a positive integer).* Required
nameA string of text, containing no newlines or other control characters.

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA valid id number (a positive integer).
nameA string of text, containing no newlines or other control characters.* Optional
submitted_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
ticket_idA 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:

ParameterTypeNotes
idA valid id number (a positive integer).* Required
restrictA boolean value (0 or 1).

Returns:

FieldType
validatedA boolean value (0 or 1).

Possible Errors:

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