Overview
Error Handling

Methods

API Documentation (API Version bleed)

Asset/Network/Private/

Description

Methods for working with a sub-account's in Global Private (network) Fabric(s)

create

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/create

Description:

Create a sub-account link to a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
network_private_idA valid id number (a positive integer).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
idA valid id number (a positive integer).
ip_addressAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
network_private_idA valid id number (a positive integer).
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

delete

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/delete

Description:

Delete a sub-account link to a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
idA valid id number (a positive integer).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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

eligible

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/eligible

Description:

Returns sub-account(s) eligible to be linked to a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'acronisBackingUp', 'altGroup', 'ancestorServer', 'associationDetails', 'backupsAndStorage', 'businessEmailPricing', 'capabilities', 'categories', 'children', 'creation_date', 'custom_description', 'description', 'diskDetails', 'distro', 'emailFriendlyName', 'featureDetails', 'finalizeDetails', 'generatedDomainDetails', 'hostedEmailPricing', 'hostedEmailUsage', 'hostingDetails', 'instance', 'loadbalancer', 'machine', 'managedType', 'mesDetails', 'monitorableServices', 'mrc', 'networkSummary', 'nocworxRemoteDetails', 'nocworxServiceDetails', 'objectStore', 'osFamily', 'parentDetails', 'powerStatus', 'price', 'primaryProductCategory', 'privateParent', 'product', 'productDisplayGroup', 'project', 'prometheusDetails', 'publicProductCategory', 'region', 'resourceState', 'servers', 'shortDescription', 'template', 'templateApp', 'usageDetails', 'zone'
network_private_idA valid id number (a positive integer).* Required

Returns:

FieldType
assetsAn array of associative arrays containing
 
altGroupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
custom_nameA string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255)* Optional
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
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.
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
project_idA positive integer value (i.e. 1 and up).* Optional
project_nameA string permitting tabs, carriage returns and newlines* Optional
region_idA positive integer value (i.e. 1 and up).
statusOne of: 'Active', 'BucketPart', 'Disabled', 'New', 'Pending-Activation', 'Pending-Config', 'Pending-Payment', 'Pending-Termination', 'Terminated'
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.
uniq_idA six-character identifier, containing only capital letters and digits.
usernameEither: a subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).; or a fixed-length identifier, 6 characters in length, containing only capital letters and numbers.* Optional

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/list

Description:

Returns a list of all Global Private (network) Fabric links for an account, sub-account uniq_id, or a specific Global Private (network) Fabric ID.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
network_private_idA valid id number (a positive integer).
order_byAn associative array containing the fields:
 
fieldOne of: 'id', 'ip_address', 'network_private_id'* 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
uniq_idA six-character identifier, containing only capital letters and digits.

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
 
idA valid id number (a positive integer).
ip_addressAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Optional
network_private_idA valid id number (a positive integer).
uniq_idA six-character identifier, containing only capital letters and digits.
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