Overview
Error Handling

Methods

API Documentation (API Version bleed)

Migration/Account/Server/Access/

DESCRIPTION

This section contains methods for migration server access credentials.

create

URL:

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

Description:

Create a migration access credential.

Parameters:

ParameterTypeNotes
db_nameA string of text, containing no newlines or other control characters.
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
server_idA valid id number (a positive integer).* Required
typeA string of text, containing no newlines or other control characters.* Required
urlA string of text, containing no newlines or other control characters.
usernameA string of text, containing no newlines or other control characters.

Returns:

FieldTypeNotes
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

Possible Errors:

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

delete

URL:

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

Description:

Delete an existing migration access credential

Parameters:

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

Returns:

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

Possible Errors:

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

details

URL:

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

Description:

Returns the details for a specific migration access credential

Parameters:

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

Returns:

FieldTypeNotes
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

Possible Errors:

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

list

URL:

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

Description:

Return a list of migration access credentials.

Parameters:

ParameterTypeNotes
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.
explainA string permitting tabs, carriage returns and newlines
idA valid id number (a positive integer).
order_byAn associative array containing the fields:
 
fieldOne of: 'created_date', 'id', 'server_id', 'touched_date', 'type'* 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
portA positive integer value (i.e. 1 and up).
resellerA boolean value (0 or 1).
secretA string permitting tabs, carriage returns and newlines
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.
usernameA string of text, containing no newlines or other control characters.

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

listTypes

URL:

https://api.liquidweb.com/bleed/Migration/Account/Server/Access/listTypes

Description:

Lists the server access types

Parameters:

No Values Defined

Returns:

FieldType
typesAn array of 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/Migration/Account/Server/Access/update

Description:

Update an existing migration access credential.

Parameters:

ParameterTypeNotes
db_nameA string of text, containing no newlines or other control characters.
explainA string permitting tabs, carriage returns and newlines
idA valid id number (a positive integer).* Required
portA positive integer value (i.e. 1 and up).
resellerA boolean value (0 or 1).
secretA string permitting tabs, carriage returns and newlines
server_idA valid id number (a positive integer).
typeA string of text, containing no newlines or other control characters.
urlA string of text, containing no newlines or other control characters.
usernameA string of text, containing no newlines or other control characters.

Returns:

FieldTypeNotes
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

Possible Errors:

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