Overview
Error Handling

Methods

API Documentation (API Version bleed)

Migration/Account/Server/

DESCRIPTION

This section contains methods for migration server data.

A migration server can be a source server (from) or a destination (to) server. It contains the location and how to access the server as well as notes specific to that server.

create

URL:

https://api.liquidweb.com/bleed/Migration/Account/Server/create

Description:

Create a migration server.

Parameters:

ParameterTypeNotes
account_idA valid id number (a positive integer).* Required
backup_detailsA string permitting tabs, carriage returns and newlines
backup_locationA string of text, containing no newlines or other control characters.
cron_jobsA string permitting tabs, carriage returns and newlines
databasesA string permitting tabs, carriage returns and newlines
domainA string of text, containing no newlines or other control characters.
email_detailsA string permitting tabs, carriage returns and newlines
hostnameA string of text, containing no newlines or other control characters.
ipA valid IP address (v4 or v6)
notesA string permitting tabs, carriage returns and newlines
platformA string of text, containing no newlines or other control characters.
serverAccessAn associative array containing the fields:
 
explainA string permitting tabs, carriage returns and newlines
portA positive integer value (i.e. 1 and up).
resellerA boolean value (0 or 1).
secretA string permitting tabs, carriage returns and newlines
typeOne of: 'ftp', 'other', 'plesk', 'ssh', 'whm_cpanel', 'wp'* Required
urlA string of text, containing no newlines or other control characters.
usernameA string of text, containing no newlines or other control characters.
transfer_contentA string permitting tabs, carriage returns and newlines
transfer_typeA string of text, containing no newlines or other control characters.
typeA string of text, containing no newlines or other control characters.
usernameA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
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
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

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Migration/Account/Server/delete

Description:

Delete an existing migration server

Parameters:

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

Returns:

FieldType
deletedAn associative array containing the fields:
 
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
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
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

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Migration/Account/Server/details

Description:

Returns the details for a specific migration server

Parameters:

ParameterTypeNotes
alsowithAn array of The value: 'databaseAccesses'
idA valid id number (a positive integer).* Required

Returns:

FieldTypeNotes
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
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

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Migration/Account/Server/list

Description:

Return a list of migration servers.

Parameters:

ParameterTypeNotes
account_idA valid id number (a positive integer).
domainA string of text, containing no newlines or other control characters.
hostnameA string of text, containing no newlines or other control characters.
idA valid id number (a positive integer).
ipA valid IP address (v4 or v6)
migration_idA valid id number (a positive integer).
order_byAn associative array containing the fields:
 
fieldOne of: 'account_id', 'hostname', 'id', 'platform', 'type'* Optional
  • Defaults to: account_id
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
platformA string of text, containing no newlines or other control characters.
typeA string of text, containing no newlines or other control characters.
usernameA string permitting tabs, carriage returns and newlines

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
 
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
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
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
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

update

URL:

https://api.liquidweb.com/bleed/Migration/Account/Server/update

Description:

Update an existing migration server.

Parameters:

ParameterTypeNotes
backup_detailsA string permitting tabs, carriage returns and newlines
backup_locationA string of text, containing no newlines or other control characters.
cron_jobsA string permitting tabs, carriage returns and newlines
databasesA string permitting tabs, carriage returns and newlines
domainA string of text, containing no newlines or other control characters.
email_detailsA string permitting tabs, carriage returns and newlines
hostnameA string of text, containing no newlines or other control characters.
idA valid id number (a positive integer).* Required
ipA valid IP address (v4 or v6)
notesA string permitting tabs, carriage returns and newlines
platformA string of text, containing no newlines or other control characters.
serverAccessAn associative array containing the fields:
 
explainA string permitting tabs, carriage returns and newlines
portA positive integer value (i.e. 1 and up).
resellerA boolean value (0 or 1).
secretA string permitting tabs, carriage returns and newlines
typeOne of: 'ftp', 'other', 'plesk', 'ssh', 'whm_cpanel', 'wp'
urlA string of text, containing no newlines or other control characters.
usernameA string of text, containing no newlines or other control characters.
transfer_contentA string permitting tabs, carriage returns and newlines
transfer_typeA string of text, containing no newlines or other control characters.
typeA string of text, containing no newlines or other control characters.
usernameA string permitting tabs, carriage returns and newlines

Returns:

FieldTypeNotes
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
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

Possible Errors:

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