Overview
Error Handling

Methods

API Documentation (API Version bleed)

Project/

DESCRIPTION

This section of the API allows for working with projects and their related assets

add

URL:

https://api.liquidweb.com/bleed/Project/add

Description:

Add to an existing project.

Parameters:

ParameterTypeNotes
assetsAn array of a six-character identifier, containing only capital letters and digits.* Required
clusterA boolean value (0 or 1).* Optional
  • Defaults to: 0
idA positive integer value (i.e. 1 and up).* Required if:
  • project_name is not given
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required if:
  • id is not given

Returns:

FieldType
addedA boolean value (0 or 1).

Possible Errors:

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

available

URL:

https://api.liquidweb.com/bleed/Project/available

Description:

Check to see if a project name is available.

Parameters:

ParameterTypeNotes
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required

Returns:

FieldType
availableA boolean value (0 or 1).

Possible Errors:

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

availableAssets

URL:

https://api.liquidweb.com/bleed/Project/availableAssets

Description:

Returns a list of assets that could potentially be added to the given project, grouped by category

Parameters:

ParameterTypeNotes
categoryOne of: 'domains', 'servers', 'services'* Required
idA positive integer value (i.e. 1 and up).
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.

Returns:

FieldType
assetsAn array of an associative array of arbitrary keys and values.

Possible Errors:

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

categories

URL:

https://api.liquidweb.com/bleed/Project/categories

Description:

Lists project categories.

Parameters:

No Values Defined

Returns:

FieldType
categoriesAn array of a single word, consisting of only letters and digits.

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/Project/create

Description:

Create a new project.

Parameters:

ParameterTypeNotes
assetsAn array of a six-character identifier, containing only capital letters and digits.
clusterA boolean value (0 or 1).* Optional
  • Defaults to: 0
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
idA positive integer value (i.e. 1 and up).
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Project/delete

Description:

Delete an existing project.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • project_name is not given
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required if:
  • id is not given

Returns:

FieldType
deletedA boolean value (0 or 1).

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Project/details

Description:

Show the details of one specific project

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • project_name is not given
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required if:
  • id is not given

Returns:

FieldTypeNotes
domainsAn array of associative arrays containing
 
dnsAn associative array containing the fields:* Optional
 
uniq_idA six-character identifier, containing only capital letters and digits.
dregAn associative array containing the fields:* Optional
 
autorenewA boolean value (0 or 1).
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.
redemptionA boolean value (0 or 1).
renewableA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.
sslAn associative array containing the fields:* Optional
 
autorenewA boolean value (0 or 1).* Optional
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
renewableA boolean value (0 or 1).* Optional
typeOne of: 'DV', 'EV', 'OV'
uniq_idA six-character identifier, containing only capital letters and digits.
project_idA valid id number (a positive integer).
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.
serversAn array of an associative array of arbitrary keys and values.* Optional
servicesAn array of an associative array of arbitrary keys and values.* Optional

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Project/list

Description:

Returns a paginated list of projects and related assets

Parameters:

ParameterTypeNotes
order_byAn associative array containing the fields:
 
fieldOne of: 'project_id', 'project_name'* Optional
  • Defaults to: project_name
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
 
domainsAn array of associative arrays containing
 
dnsAn associative array containing the fields:* Optional
 
uniq_idA six-character identifier, containing only capital letters and digits.
dregAn associative array containing the fields:* Optional
 
autorenewA boolean value (0 or 1).
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.
redemptionA boolean value (0 or 1).
renewableA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.
sslAn associative array containing the fields:* Optional
 
autorenewA boolean value (0 or 1).* Optional
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format.* Optional
renewableA boolean value (0 or 1).* Optional
typeOne of: 'DV', 'EV', 'OV'
uniq_idA six-character identifier, containing only capital letters and digits.
project_idA valid id number (a positive integer).
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.
serversAn array of an associative array of arbitrary keys and values.* Optional
servicesAn array of an associative array of arbitrary keys and values.* 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

remove

URL:

https://api.liquidweb.com/bleed/Project/remove

Description:

Remove an asset or assets from a project.

Parameters:

ParameterTypeNotes
assetsAn array of a six-character identifier, containing only capital letters and digits.* Required
idA positive integer value (i.e. 1 and up).* Required if:
  • project_name is not given
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required if:
  • id is not given

Returns:

FieldType
removedA boolean value (0 or 1).

Possible Errors:

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

rename

URL:

https://api.liquidweb.com/bleed/Project/rename

Description:

Rename a given project

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required if:
  • project_name is not given
new_project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.* Required if:
  • id is not given

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
idA positive integer value (i.e. 1 and up).
project_nameA string consisting of only letters, digits, hyphens, spaces, and underscores.

Possible Errors:

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