module Arbor::Peakflow::Alerts

Public Instance Methods

alerts(filter = nil, limit = nil, format = 'json') click to toggle source

The alerts function allows you to search for and retrieve JSON or XML alert information.

Parameters:

  • filter: (Optional) Keywords by which you want to filter search results. You can enter the same search strings that you can enter in the Search box on the Alerts pages in the Web UI.

  • limit: (Optional) The maximum number of alerts to return that match the filter.

  • format: The format in which you want the data returned: ‘json` or `xml`

Example

response = client.alerts 'host', 100, 'json'
# File lib/arbor_peakflow_ruby/actions/alerts.rb, line 15
def alerts(filter = nil, limit = nil, format = 'json')
  url_filter_limit_format_request('arborws/alerts', filter, limit, format)
end