Class: CtdDocumentation::AlertsController

Inherits:

BaseController

Object
BaseController
CtdDocumentation::AlertsController

show all

Defined in:: lib/ctd_documentation/controllers/alerts_controller.rb

Overview

AlertsController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

#find_alert_by_id(resource_id) ⇒ Alert

Get a single alert.
#get_alerts(page: nil, per_page: nil, asset_id__exact: nil, asset__exact: nil, for_asset__exact: nil, q__exact: nil, primary_asset__exact: nil, non_primary_assets__exact: nil, virtual_zone__exact: nil, alert_id__exact: nil, ot_alerts__exact: nil, family__exact: nil, story_severity__exact: nil, id__exact: nil, site_id__exact: nil, data__exact: nil, description__exact: nil, type__exact: nil, category__exact: nil, severity__exact: nil, timestamp__exact: nil, last_updated__gte: nil, relevant__exact: nil, resolved__exact: nil, resolution__exact: nil, protocol__exact: nil, score__exact: nil, is_qualified__exact: nil, network_id__exact: nil, resolved_id__exact: nil, assigned_id__exact: nil, story_id__exact: nil, sort: nil) ⇒ GetAlertsResponse

Retrieves a list of Alerts in CTD, with optional filters.

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from CtdDocumentation::BaseController

Instance Method Details

#find_alert_by_id(resource_id) ⇒ `Alert`

Get a single alert. to return

Parameters:

resource_id (String) —

Required parameter: Resource ID of the Alert

Returns:

(Alert) —

response from the API call

# File 'lib/ctd_documentation/controllers/alerts_controller.rb', line 155

def find_alert_by_id(resource_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/ranger/alerts/{resource_id}',
                                 Server::DEFAULT)
               .template_param(new_parameter(resource_id, key: 'resource_id')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('global')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(Alert.method(:from_hash)))
    .execute
end

#get_alerts(page: nil, per_page: nil, asset_idexact: nil, assetexact: nil, for_assetexact: nil, qexact: nil, primary_asset__exact: nil, non_primary_assets__exact: nil, virtual_zone__exact: nil, alert_id__exact: nil, ot_alertsexact: nil, familyexact: nil, story_severityexact: nil, idexact: nil, site_idexact: nil, dataexact: nil, descriptionexact: nil, typeexact: nil, categoryexact: nil, severityexact: nil, timestamp__exact: nil, last_updatedgte: nil, relevantexact: nil, resolvedexact: nil, resolutionexact: nil, protocolexact: nil, scoreexact: nil, is_qualified__exact: nil, network_id__exact: nil, resolved_id__exact: nil, assigned_id__exact: nil, story_id__exact: nil, sort: nil) ⇒ `GetAlertsResponse`

Retrieves a list of Alerts in CTD, with optional filters. Note - All filters are optional. each page. (The maximum is 500). Asset of the primary asset that triggered the alert of the non-primary assets involved in the alert the Zone that triggered the alert Alert. You can add multiple IDs. Asset involved in the Alert, for example Policy Violation. Alert Families appear in the Advanced Options filter of Alerts. which the Alert occurred alert Threat, New Conflict Asset, etc. Integrity, 1 = Security Low, 1 = Medium, 2 = High, 3 = Critical the Alert occured. Format: YYYY-MM-DD**T**HH:MM:SS (in UTC) Example: 2022-11-01T16:22:05 the latest change on the Alert was made in the EMC. Format: YYYY-MM-DD**T**HH:MM:SS (in UTC) Example: 2022-11-01T16:22:05 Example: or not an Alert was resolved: True = resolved, False = not resolved resolution. alert, for example: S7Comm for this alert, on a score of 1-100 Example: which the Alert was assigned to which the Alert belongs - can be viewed in the UI by selecting “Group By Story” in ascending order of the sort attribute. The sorting prefix “-” sorts the results in descending order of the sort attribute.