URL:

https://api.liquidweb.com/v1/Notifications/all

Description:

Get a list of all notifications for an account or server. More information about the data structure can be found in the storm/alerts/details method.

Parameters:

Parameter	Type	Notes
category	A string of text, containing no newlines or other control characters.
page_num	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 1
page_size	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 25
resolved	A boolean value (0 or 1).
system	A string consisting of only letters, digits, hyphens, spaces, and underscores.
uniq_id	A six-character identifier, containing only capital letters and digits.

Returns:

Field	Type
item_count	A non-negative integer value (i.e. 0 and up).
item_total	A non-negative integer value (i.e. 0 and up).
items	An array of associative arrays containing
	category A string of text, containing no newlines or other control characters. * Optional description A string permitting tabs, carriage returns and newlines domain A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) * Optional enddate A valid date and time in YYYY-MM-DD HH:MM:SS format. * Optional id A positive integer value (i.e. 1 and up). last_alert A string permitting tabs, carriage returns and newlines * Optional modifieddate A valid date and time in YYYY-MM-DD HH:MM:SS format. resolved A boolean value (0 or 1). severity A single word, consisting of only letters and digits. startdate A valid date and time in YYYY-MM-DD HH:MM:SS format. system A string consisting of only letters, digits, hyphens, spaces, and underscores. system_identifier A positive integer value (i.e. 1 and up). * Optional uniq_id A six-character identifier, containing only capital letters and digits. * Optional
page_num	A positive integer value (i.e. 1 and up).
page_size	A positive integer value (i.e. 1 and up).
page_total	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Notifications/current

Description:

Get a list of unresolved notifications for an account or server. More information about the data structure can be found in the storm/alerts/details method.

Parameters:

Parameter	Type	Notes
category	A string of text, containing no newlines or other control characters.
page_num	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 1
page_size	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 25
severity	A single word, consisting of only letters and digits.
system	A string consisting of only letters, digits, hyphens, spaces, and underscores.
uniq_id	A six-character identifier, containing only capital letters and digits.

Returns:

Field	Type
item_count	A non-negative integer value (i.e. 0 and up).
item_total	A non-negative integer value (i.e. 0 and up).
items	An array of associative arrays containing
	category A string of text, containing no newlines or other control characters. * Optional description A string permitting tabs, carriage returns and newlines domain A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) * Optional enddate A valid date and time in YYYY-MM-DD HH:MM:SS format. * Optional id A positive integer value (i.e. 1 and up). last_alert A string permitting tabs, carriage returns and newlines * Optional modifieddate A valid date and time in YYYY-MM-DD HH:MM:SS format. resolved A boolean value (0 or 1). severity A single word, consisting of only letters and digits. startdate A valid date and time in YYYY-MM-DD HH:MM:SS format. system A string consisting of only letters, digits, hyphens, spaces, and underscores. system_identifier A positive integer value (i.e. 1 and up). * Optional uniq_id A six-character identifier, containing only capital letters and digits. * Optional
page_num	A positive integer value (i.e. 1 and up).
page_size	A positive integer value (i.e. 1 and up).
page_total	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Notifications/details

Description:

Gets information about a specific notification, including a history of all the alerts related to that notification. You can limit the number of historical alerts by specifying a 'limit'.

Here's a rundown of what those fields mean:

	accnt: your account number

	category: the category of alert, if any.  Examples are (list likely to grow):

		Provisioning - an alert from our provisioning system, which handles long-
		running background processes like creating servers, rebooting, etc

		Monitoring:* - our service monitoring system creates alerts in various
		categories based on which server was having issues.  Monitoring: host
		indicates that the primary service on the server was having issues.
		Other examples are Monitoring: http, Monitoring: mysql, etc.

		Bandwidth Overage Warning - you have exceeded or are within a certain
		percentage of your bandwidth quota on a server

	description: the original description of the alert

	enddate: the date and time the alert was closed, if it is closed

	id: the id for this alert

	modifieddate: the date and time the alert was last updated

	severity:  the class of alert

		Notification: this alert is just to let you know that something has
		happened or is happening.

		Warning: indicates that something may be wrong, but is not yet serious.

		Error: something is wrong, like a service is not responding at all.

		Critical: something is seriously wrong and requires user acknowledgement
		to be closed.  Failed background processes from the provisioning system
		are the primary example here.

	system: the system reporting the alert

		Provisioning: alerts from our provisioning system, which handle
		long-running background tasks, like building servers, rebooting, etc

		Service Monitoring: alerts from our service monitoring system

		Storm: alerts related to Storm downtime or maintenance

		Billing: alerts from our billing system.  Things like bandwidth overage
		notifications.

	system_indentifier: some of the systems maintain their own unique identifiers
	for each ongoing alert.  This is that identifier, if it exists.

	uniq_id: the unique server identifier, made of 6 letters and numbers

	alerts: if an alert is repeated or has progress updates, each individual
	alert is kept and returns as a list here.  Other methods like list and open
	do not return this bit of information

Parameters:

Parameter	Type	Notes
id	A positive integer value (i.e. 1 and up).
limit	A non-negative integer value (i.e. 0 and up).
system	A string consisting of only letters, digits, hyphens, spaces, and underscores.	* Required if: id is not given
system_identifier	A non-negative integer value (i.e. 0 and up).	* Required if: id is not given

Returns:

Field	Type	Notes
alerts	An array of associative arrays containing	* Optional
	alertdate A valid date and time in YYYY-MM-DD HH:MM:SS format. description A string.
category	A string of text, containing no newlines or other control characters.	* Optional
description	A string permitting tabs, carriage returns and newlines
domain	A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)	* Optional
enddate	A valid date and time in YYYY-MM-DD HH:MM:SS format.	* Optional
id	A positive integer value (i.e. 1 and up).
last_alert	A string permitting tabs, carriage returns and newlines	* Optional
modifieddate	A valid date and time in YYYY-MM-DD HH:MM:SS format.
resolved	A boolean value (0 or 1).
severity	A single word, consisting of only letters and digits.
startdate	A valid date and time in YYYY-MM-DD HH:MM:SS format.
system	A string consisting of only letters, digits, hyphens, spaces, and underscores.
system_identifier	A positive integer value (i.e. 1 and up).	* Optional
uniq_id	A six-character identifier, containing only capital letters and digits.	* Optional

Possible Errors:

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

URL:

https://api.liquidweb.com/v1/Notifications/resolve

Description:

Resolve an existing open notification. It will be marked as 'resolved' and no longer be returned by the 'current' method.

Parameters:

Parameter	Type	Notes
id	A positive integer value (i.e. 1 and up).
system	A string consisting of only letters, digits, hyphens, spaces, and underscores.	* Required if: id is not given
system_identifier	A non-negative integer value (i.e. 0 and up).	* Required if: id is not given

Returns:

Field	Type	Notes
category	A string of text, containing no newlines or other control characters.	* Optional
description	A string permitting tabs, carriage returns and newlines
domain	A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)	* Optional
enddate	A valid date and time in YYYY-MM-DD HH:MM:SS format.	* Optional
id	A positive integer value (i.e. 1 and up).
last_alert	A string permitting tabs, carriage returns and newlines	* Optional
modifieddate	A valid date and time in YYYY-MM-DD HH:MM:SS format.
resolved	A boolean value (0 or 1).
severity	A single word, consisting of only letters and digits.
startdate	A valid date and time in YYYY-MM-DD HH:MM:SS format.
system	A string consisting of only letters, digits, hyphens, spaces, and underscores.
system_identifier	A positive integer value (i.e. 1 and up).	* Optional
uniq_id	A six-character identifier, containing only capital letters and digits.	* Optional

Possible Errors:

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