Overview
Error Handling

Methods

API Documentation (API Version bleed)

Basket/Domain/

DESCRIPTION

This section of the API allows for performing basket domain specific functions

basketGet

URL:

https://api.liquidweb.com/bleed/Basket/Domain/basketGet

Description:

Gets domain details for a specific basket.

Parameters:

ParameterTypeNotes
basket_uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
detailsAn associative array of arbitrary keys and values.
domainA string of text, containing no newlines or other control characters.

Possible Errors:

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

basketSet

URL:

https://api.liquidweb.com/bleed/Basket/Domain/basketSet

Description:

Sets domain details for a basket.

Parameters:

ParameterTypeNotes
basket_uuidA valid UUID (Universally Unique IDentifier).* Required
domainA string of text, containing no newlines or other control characters.* Required

Returns:

FieldType
detailsAn associative array of arbitrary keys and values.
domainA string of text, containing no newlines or other control characters.

Possible Errors:

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

itemGet

URL:

https://api.liquidweb.com/bleed/Basket/Domain/itemGet

Description:

Gets domain details for a specific basket item.

Parameters:

ParameterTypeNotes
item_uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
assigned_subdomainA fragment of a valid domain name, suitable for partial domain searching* Optional
custom_domainA string of text, containing no newlines or other control characters.* Optional
custom_subdomainA fragment of a valid domain name, suitable for partial domain searching* Optional
item_uuidA valid UUID (Universally Unique IDentifier).

Possible Errors:

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

itemSet

URL:

https://api.liquidweb.com/bleed/Basket/Domain/itemSet

Description:

Sets domain details for a specific basket item.

Parameters:

ParameterTypeNotes
autocorrectA boolean value (0 or 1).
domainA string of text, containing no newlines or other control characters.
item_uuidA valid UUID (Universally Unique IDentifier).* Required
subdomainA fragment of a valid domain name, suitable for partial domain searching

Returns:

FieldTypeNotes
assigned_subdomainA fragment of a valid domain name, suitable for partial domain searching* Optional
custom_domainA string of text, containing no newlines or other control characters.* Optional
custom_subdomainA fragment of a valid domain name, suitable for partial domain searching* Optional
item_uuidA valid UUID (Universally Unique IDentifier).

Possible Errors:

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

resetCustomDomains

URL:

https://api.liquidweb.com/bleed/Basket/Domain/resetCustomDomains

Description:

Resets the `custom_domain` property on all items on a basket to 'null'

Parameters:

ParameterTypeNotes
basket_uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
detailsAn associative array of arbitrary keys and values.
domainA string of text, containing no newlines or other control characters.

Possible Errors:

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