Overview
Error Handling

Methods

API Documentation (API Version bleed)

WordPress/Domain/

DESCRIPTION

This section contains methods for managed WordPress.

backups

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/backups

Description:

Retrieve a backup list for a WordPress domain.

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
backupsAn array of associative arrays containing
 
backup_dateA string of text, containing no newlines or other control characters.
nameA string of text, containing no newlines or other control characters.
sizeA positive integer value (i.e. 1 and up).
verA string of text, containing no newlines or other control characters.

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/create

Description:

Create a new WordPress domain.

Parameters:

ParameterTypeNotes
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters.* Required
emailA valid email address.* Required
featuresAn associative array of arbitrary keys and values.
parent_uniq_idA six-character identifier, containing only capital letters and digits.* Required
passwordA password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.* Required
usernameA username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers).* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters.
emailA valid email address.
featuresAn associative array of arbitrary keys and values.* Optional
parent_uniq_idA six-character identifier, containing only capital letters and digits.
passwordA password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.
usernameA username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers).

Possible Errors:

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

createStagingSite

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/createStagingSite

Description:

Create a staging site that is a copy of the existing site

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
domain_uniq_idA six-character identifier, containing only capital letters and digits.
passwordA string permitting tabs, carriage returns and newlines
usernameA string permitting tabs, carriage returns and newlines

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/delete

Description:

Delete a new WordPress domain.

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
deletedA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

Possible Errors:

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

installSignedSSL

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/installSignedSSL

Description:

Attempt the install of a signed SSL for the WordPress Domain

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldTypeNotes
pendingA boolean value (0 or 1).* Optional
pending_sinceEither: a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.; or a valid SQL time command, e.g. now()* Optional
ssl_typeOne of: 'none', 'self-signed', 'signed'* Optional
ssl_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
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/WordPress/Domain/list

Description:

List domains for the subaccount.

Parameters:

ParameterTypeNotes
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
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters.
emailA valid email address.
featuresAn associative array of arbitrary keys and values.* Optional
parent_uniq_idA six-character identifier, containing only capital letters and digits.
passwordA password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.
usernameA username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers).

Possible Errors:

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

removeStagingSite

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/removeStagingSite

Description:

Create a staging site that is a copy of the existing site

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
removedA boolean value (0 or 1).
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

restore

URL:

https://api.liquidweb.com/bleed/WordPress/Domain/restore

Description:

Restores a backup for a WordPress domain.

Parameters:

ParameterTypeNotes
filenameA string of text, containing no newlines or other control characters.* Required
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
restoringA 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/WordPress/Domain/update

Description:

Create a new WordPress domain.

Parameters:

ParameterTypeNotes
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters.
featuresAn associative array of arbitrary keys and values.
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a string of text, containing no newlines or other control characters.
emailA valid email address.
featuresAn associative array of arbitrary keys and values.* Optional
parent_uniq_idA six-character identifier, containing only capital letters and digits.
passwordA password of at least 7 characters and up to 30 characters in length, containing no spaces. Must contain 3 of the 4 following classes: lowercase, uppercase, numbers and punctuation.
usernameA username for cPanel accounts, consisting of an initial letter followed by up to 7 additional characters (letters or numbers).

Possible Errors:

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