Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/Region/

DESCRIPTION

Through these api methods, you can lookup network regions.

details

URL:

https://api.liquidweb.com/bleed/Network/Region/details

Description:

Returns a single region

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
asnA positive integer value (i.e. 1 and up).
host_prefixA single word, consisting of only letters and digits. (Maximum length: 3)
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 100)

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Network/Region/list

Description:

Returns a list of regions.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
order_byAn associative array containing the fields:
 
fieldOne of: 'asn', 'host_prefix', 'id', 'name'* Required
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
 
asnA positive integer value (i.e. 1 and up).
host_prefixA single word, consisting of only letters and digits. (Maximum length: 3)
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 100)
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