Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

AlertsApi.md

Latest commit

 

History

History
208 lines (144 loc) · 9.44 KB

AlertsApi.md

File metadata and controls

208 lines (144 loc) · 9.44 KB

AlertsApi

All URIs are relative to http://localhost/

Method HTTP request Description
listComplianceControls GET api/v2/alerts/{alert_id}/compliance_controls.json_api Get a list of Compliance Controls for an Alert
listCustomComplianceControls GET api/v2/alerts/{alert_id}/custom_compliance_controls.json_api Get a list of Custom Compliance Controls for an Alert
listForReport PUT api/v2/reports/{report_id}/alerts.json_api Get a list of Alerts for a Report
show GET api/v2/alerts/{id}.json_api Show a single Alert

listComplianceControls

PaginatedCollection listComplianceControls(alertId, include, page)

Get a list of Compliance Controls for an Alert

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.AlertsApi;


AlertsApi apiInstance = new AlertsApi();
Integer alertId = 56; // Integer | The ID of the alert the compliance controls belong to
String include = "include_example"; // String | Related objects that can be included in the response:  compliance_standard, compliance_domain, signatures See Including Objects for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.listComplianceControls(alertId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertsApi#listComplianceControls");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
alertId Integer The ID of the alert the compliance controls belong to
include String Related objects that can be included in the response: compliance_standard, compliance_domain, signatures See Including Objects for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

listCustomComplianceControls

PaginatedCollection listCustomComplianceControls(alertId, include, page)

Get a list of Custom Compliance Controls for an Alert

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.AlertsApi;


AlertsApi apiInstance = new AlertsApi();
Integer alertId = 56; // Integer | The ID of the alert the custom compliance controls belong to
String include = "include_example"; // String | Related objects that can be included in the response:  custom_compliance_standard, custom_compliance_domain, signatures, custom_signatures See Including Objects for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.listCustomComplianceControls(alertId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertsApi#listCustomComplianceControls");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
alertId Integer The ID of the alert the custom compliance controls belong to
include String Related objects that can be included in the response: custom_compliance_standard, custom_compliance_domain, signatures, custom_signatures See Including Objects for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

listForReport

PaginatedCollection listForReport(reportId, include, filter, page)

Get a list of Alerts for a Report

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.AlertsApi;


AlertsApi apiInstance = new AlertsApi();
Integer reportId = 56; // Integer | ID of the Report to Return Alerts For
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, region, signature, custom_signature, suppression, metadata, attribution, cloud_trail_events, tags, compliance_controls See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attribute: [id]  Limited Searchable Attributes: [signature_service_id_in, signature_risk_level_in, risk_level_in, risk_level_eq, resource_or_tag_cont, suppressed, not_suppressed, signature_name_cont, signature_identifier_cont, external_account_id_in, external_account_id_eq, external_account_team_id_in, external_account_team_id_eq, external_account_organization_id_in, external_account_organization_id_eq, region_id_in, region_id_eq, status_in, status_eq, attribution_present, cloud_trail_events_present, open_as_of, signature_id_in, signature_id_eq, external_account_provider_eq, compliance_control_id_eq, custom_compliance_control_id_eq]  
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.listForReport(reportId, include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertsApi#listForReport");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
reportId Integer ID of the Report to Return Alerts For
include String Related objects that can be included in the response: external_account, region, signature, custom_signature, suppression, metadata, attribution, cloud_trail_events, tags, compliance_controls See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attribute: [id] Limited Searchable Attributes: [signature_service_id_in, signature_risk_level_in, risk_level_in, risk_level_eq, resource_or_tag_cont, suppressed, not_suppressed, signature_name_cont, signature_identifier_cont, external_account_id_in, external_account_id_eq, external_account_team_id_in, external_account_team_id_eq, external_account_organization_id_in, external_account_organization_id_eq, region_id_in, region_id_eq, status_in, status_eq, attribution_present, cloud_trail_events_present, open_as_of, signature_id_in, signature_id_eq, external_account_provider_eq, compliance_control_id_eq, custom_compliance_control_id_eq] [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

show

Alert show(id, include)

Show a single Alert

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.AlertsApi;


AlertsApi apiInstance = new AlertsApi();
Integer id = 56; // Integer | Alert ID
String include = "include_example"; // String | Related objects that can be included in the response:  external_account, region, signature, custom_signature, suppression, metadata, attribution, cloud_trail_events, tags, compliance_controls See Including Objects for more information.
try {
    Alert result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertsApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer Alert ID
include String Related objects that can be included in the response: external_account, region, signature, custom_signature, suppression, metadata, attribution, cloud_trail_events, tags, compliance_controls See Including Objects for more information. [optional]

Return type

Alert

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json