Overview
Error Handling

Methods

API Documentation (API Version bleed)

Asset/Monitoring/

DESCRIPTION

This section of the API allows for remotely querying service status data, service monitoring configuration details, setting the monitoring configuration for a server, as well as converting an asset or account between different monitoring backends.

assert

URL:

https://api.liquidweb.com/bleed/Asset/Monitoring/assert

Description:

Declares the state of the monitoring settings for a given subaccount. if the settings record doesn't exists, it will be created.

Parameters:

ParameterTypeNotes
enabledA boolean value (0 or 1).
servicesAn array of associative arrays containing
 
enabledA boolean value (0 or 1).* Required
nameA single word, consisting of only letters, digits, hyphens, and underscores.* Required
subaccntA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
enabledA boolean value (0 or 1).
ipA valid IP address (v4 or v6)
labelsAn associative array of arbitrary keys and values.
server_pairA string of text, containing no newlines or other control characters.
servicesAn array of associative arrays containing
 
extra_tagsAn associative array of arbitrary keys and values.
nameA single word, consisting of only letters, digits, hyphens, and underscores.
portA non-negative integer value (i.e. 0 and up).
typeOne of: 'external', 'internal', 'machine'
subaccntA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Asset/Monitoring/details

Description:

Returns monitoring details for a requested subaccount.

Parameters:

ParameterTypeNotes
subaccntA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
enabledA boolean value (0 or 1).
ipA valid IP address (v4 or v6)
labelsAn associative array of arbitrary keys and values.
server_pairA string of text, containing no newlines or other control characters.
servicesAn array of associative arrays containing
 
extra_tagsAn associative array of arbitrary keys and values.
nameA single word, consisting of only letters, digits, hyphens, and underscores.
portA non-negative integer value (i.e. 0 and up).
typeOne of: 'external', 'internal', 'machine'
subaccntA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Asset/Monitoring/list

Description:

Returns a list of all monitoring details for a given search.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
enabledA standardized search for a boolean value (0 or 1).* Optional
  • Defaults to: 1
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
server_pairA string of text, containing no newlines or other control characters.
subaccntA 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
 
enabledA boolean value (0 or 1).
ipA valid IP address (v4 or v6)
labelsAn associative array of arbitrary keys and values.
server_pairA string of text, containing no newlines or other control characters.
servicesAn array of associative arrays containing
 
extra_tagsAn associative array of arbitrary keys and values.
nameA single word, consisting of only letters, digits, hyphens, and underscores.
portA non-negative integer value (i.e. 0 and up).
typeOne of: 'external', 'internal', 'machine'
subaccntA 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

status

URL:

https://api.liquidweb.com/bleed/Asset/Monitoring/status

Description:

returns the current monitoring status of the given monitored services.

Parameters:

ParameterTypeNotes
subaccntA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
One or more keys matching: a single word, consisting of only letters, digits, hyphens, and underscores.An associative array of arbitrary keys and values.

Possible Errors:

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