Alerts

The following resources are applicable:

/alerts

Mount Point: /v2/alerts

The following operations are supported on this resource:

GET

Returns the list of all the Alerts published under the account of the currently connected user.

Example of query in CURL :
curl --user 'clientId:client password' -k https://api-sandbox.everyware-cloud.com/v2/alerts.xml?severity=CRITICAL" | xmllint --format -

Parameters

name description type default
limit Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 50
offset Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 0
startDate Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
severity : can be one of the following CRITICAL, WARNING, INFO query
source : can be an asset name or System query
category : eg Performance, Security, Other etc ... query

Response Body

element: alertsResult
media types: application/xml
application/json

The list of requested Messages.

POST

Stores a new Alert under the account of the currently connected user. In this case, the provided alert will only be stored in the back-end database and it will not be forwarded to the message broker.

Request Body

element: alertCreator
media types: application/xml

contains parameters for the Alert to be stored.
At present only XML is supported in the request body.

Response Body

element: alert
media types: application/xml

(no documentation provided)

DELETE

Delete one alert or a group of alerts published on the account or all the alerts if no param are passed.

To delete a given alert, the best way is to use its unique identifier "uuid".
Example of query in CURL :
curl --user 'clientId:client password' -X DELETE -k "https://api-sandbox.everyware-cloud.com/v2/alerts.xml?uuid=de9959b7-b80d-4881-bffd-0d7c93523ded"

Parameters

name description type default
uuid : unique identifier of the alert to be deleted query
source : source of the alert to be deleted query
startDate : date of the alert to be deleted. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
limit Maximum number of entries to be deleted (default 50). Note that an error will be returned if the maximum allowed value is exceeded. query 50
severity : can be one of the following CRITICAL, WARNING, INFO query
category : eg Performance, Security, Other etc ... All params are optional, if source and startDate are omitted all alerts are deleted (and other params are ignored), if not source MUST BE SET.

To delete a single alert, source and startDate must be defined and endDate must not be defined.

query