Overview
Error Handling

Methods

API Documentation (API Version bleed)

CodeGuard/User/

create

URL:

https://api.liquidweb.com/bleed/CodeGuard/User/create

Description:

Parameters:

ParameterTypeNotes
emailA valid email address.* Required
nameA string of text, containing no newlines or other control characters.* Required
plan_idA positive integer value (i.e. 1 and up).

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
friendlyPlanNameA single word, consisting of only letters and digits.* Optional
loginUrlA string of text, containing no newlines or other control characters.* Optional
nameA string of text, containing no newlines or other control characters.
plan_idA positive integer value (i.e. 1 and up).
remoteDetailsAn associative array containing the fields:* Optional
 
activeA boolean value (0 or 1).
backup_retention_periodA positive integer value (i.e. 1 and up).
concurrent_backup_limitA non-negative integer value (i.e. 0 and up).
database_quotaA non-negative integer value (i.e. 0 and up).
emailA valid email address.
nameA string of text, containing no newlines or other control characters.
over_quotaA boolean value (0 or 1).
plan_idA positive integer value (i.e. 1 and up).
sizeA non-negative integer value (i.e. 0 and up).
size_limitA non-negative integer value (i.e. 0 and up).
website_countA non-negative integer value (i.e. 0 and up).
website_count_limitA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/CodeGuard/User/delete

Description:

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
friendlyPlanNameA single word, consisting of only letters and digits.* Optional
loginUrlA string of text, containing no newlines or other control characters.* Optional
nameA string of text, containing no newlines or other control characters.
plan_idA positive integer value (i.e. 1 and up).
remoteDetailsAn associative array containing the fields:* Optional
 
activeA boolean value (0 or 1).
backup_retention_periodA positive integer value (i.e. 1 and up).
concurrent_backup_limitA non-negative integer value (i.e. 0 and up).
database_quotaA non-negative integer value (i.e. 0 and up).
emailA valid email address.
nameA string of text, containing no newlines or other control characters.
over_quotaA boolean value (0 or 1).
plan_idA positive integer value (i.e. 1 and up).
sizeA non-negative integer value (i.e. 0 and up).
size_limitA non-negative integer value (i.e. 0 and up).
website_countA non-negative integer value (i.e. 0 and up).
website_count_limitA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/CodeGuard/User/details

Description:

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'friendlyPlanName', 'loginUrl', 'remoteDetails'
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
friendlyPlanNameA single word, consisting of only letters and digits.* Optional
loginUrlA string of text, containing no newlines or other control characters.* Optional
nameA string of text, containing no newlines or other control characters.
plan_idA positive integer value (i.e. 1 and up).
remoteDetailsAn associative array containing the fields:* Optional
 
activeA boolean value (0 or 1).
backup_retention_periodA positive integer value (i.e. 1 and up).
concurrent_backup_limitA non-negative integer value (i.e. 0 and up).
database_quotaA non-negative integer value (i.e. 0 and up).
emailA valid email address.
nameA string of text, containing no newlines or other control characters.
over_quotaA boolean value (0 or 1).
plan_idA positive integer value (i.e. 1 and up).
sizeA non-negative integer value (i.e. 0 and up).
size_limitA non-negative integer value (i.e. 0 and up).
website_countA non-negative integer value (i.e. 0 and up).
website_count_limitA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters and digits.
uniq_idA 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/CodeGuard/User/list

Description:

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'friendlyPlanName', 'loginUrl', 'remoteDetails'
order_byAn associative array containing the fields:
 
fieldOne of: 'created_date', 'id'* 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

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, or a DateTime object.
emailA valid email address.
friendlyPlanNameA single word, consisting of only letters and digits.* Optional
loginUrlA string of text, containing no newlines or other control characters.* Optional
nameA string of text, containing no newlines or other control characters.
plan_idA positive integer value (i.e. 1 and up).
remoteDetailsAn associative array containing the fields:* Optional
 
activeA boolean value (0 or 1).
backup_retention_periodA positive integer value (i.e. 1 and up).
concurrent_backup_limitA non-negative integer value (i.e. 0 and up).
database_quotaA non-negative integer value (i.e. 0 and up).
emailA valid email address.
nameA string of text, containing no newlines or other control characters.
over_quotaA boolean value (0 or 1).
plan_idA positive integer value (i.e. 1 and up).
sizeA non-negative integer value (i.e. 0 and up).
size_limitA non-negative integer value (i.e. 0 and up).
website_countA non-negative integer value (i.e. 0 and up).
website_count_limitA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
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/CodeGuard/User/update

Description:

Parameters:

ParameterTypeNotes
plan_idA positive integer value (i.e. 1 and up).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
emailA valid email address.
friendlyPlanNameA single word, consisting of only letters and digits.* Optional
loginUrlA string of text, containing no newlines or other control characters.* Optional
nameA string of text, containing no newlines or other control characters.
plan_idA positive integer value (i.e. 1 and up).
remoteDetailsAn associative array containing the fields:* Optional
 
activeA boolean value (0 or 1).
backup_retention_periodA positive integer value (i.e. 1 and up).
concurrent_backup_limitA non-negative integer value (i.e. 0 and up).
database_quotaA non-negative integer value (i.e. 0 and up).
emailA valid email address.
nameA string of text, containing no newlines or other control characters.
over_quotaA boolean value (0 or 1).
plan_idA positive integer value (i.e. 1 and up).
sizeA non-negative integer value (i.e. 0 and up).
size_limitA non-negative integer value (i.e. 0 and up).
website_countA non-negative integer value (i.e. 0 and up).
website_count_limitA positive integer value (i.e. 1 and up).
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

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