Overview
Error Handling

Methods

API Documentation (API Version bleed)

Domain/

DESCRIPTION

This section of the API allows for working with domain related assets

list

URL:

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

Description:

Returns a paginated list of domain related assets

Parameters:

ParameterTypeNotes
autorenewA boolean value (0 or 1).
domainEither: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a fragment of a valid domain name, suitable for partial domain searching* Required if:
  • domain_match is set to '1'
domain_matchA boolean value (0 or 1).
order_byAn associative array containing the fields:
 
fieldOne of: 'domain', 'dreg.expiration', 'ssl.expiration'* Optional
  • Defaults to: domain
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: asc
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
typesAn array of One of: 'dns', 'dreg', 'ssl'

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
 
dnsAn associative array containing the fields:* Optional
 
uniq_idA six-character identifier, containing only capital letters and digits.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
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.
is_subdomainA boolean value (0 or 1).
project_idA positive integer value (i.e. 1 and up).
project_nameA string permitting tabs, carriage returns and newlines
sslAn associative array containing the fields:* Optional
 
autorenewA boolean value (0 or 1).* Optional
detailsAn associative array of arbitrary keys and values.* 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.
wildcardA boolean value (0 or 1).* 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

related

URL:

https://api.liquidweb.com/bleed/Domain/related

Description:

Returns structured data of domain assets whose domain relates to the given domain (subdomains and other tlds). When explaining below, the terms `sub`, `base` and `tld` will be used. If the domain arg is whatever.myspecialdomain.com, the breakdown would be

  sub: whatever
  base: myspecialdomain
  tld: com

When talking about `parent_domain` we are referring to `base`.`tld` (myspecialdomain.com)

In the returned structure

parent_domain: condition: only returned if domain arg has a sub and parent_domain exists as a domain related asset contains: `base.tld`

tlds: condition: only returned if the domain arg does not contain a sub (is a parent_domain itself) contains: domains whose base is the same as the domain arg

sub_domains: condition: always returned contains: domains which have subs and whose parent_domain is the same as the domain arg

All things that are returned should exist as assets

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required

Returns:

FieldTypeNotes
parent_domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional
sub_domainsAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
tldsAn array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Optional

Possible Errors:

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