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
220 lines (152 loc) · 10.7 KB

AlertsApi.md

File metadata and controls

220 lines (152 loc) · 10.7 KB

esp_sdk.AlertsApi

All URIs are relative to https://api.evident.io

Method HTTP request Description
list_compliance_controls GET /api/v2/alerts/{alert_id}/compliance_controls.json_api Get a list of Compliance Controls for an Alert
list_custom_compliance_controls GET /api/v2/alerts/{alert_id}/custom_compliance_controls.json_api Get a list of Custom Compliance Controls for an Alert
list_for_report 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

list_compliance_controls

PaginatedCollection list_compliance_controls(alert_id, include=include, page=page)

Get a list of Compliance Controls for an Alert

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.AlertsApi()
alert_id = 56 # int | The ID of the alert the compliance controls belong to
include = 'include_example' # str | Related objects that can be included in the response:  compliance_standard, compliance_domain, signatures See Including Objects for more information. (optional)
page = '{:number=>1,+:size=>20}' # str | 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})

try: 
    # Get a list of Compliance Controls for an Alert
    api_response = api_instance.list_compliance_controls(alert_id, include=include, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->list_compliance_controls: %s\n" % e)

Parameters

Name Type Description Notes
alert_id int The ID of the alert the compliance controls belong to
include str Related objects that can be included in the response: compliance_standard, compliance_domain, signatures See Including Objects for more information. [optional]
page str 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

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_custom_compliance_controls

PaginatedCollection list_custom_compliance_controls(alert_id, include=include, page=page)

Get a list of Custom Compliance Controls for an Alert

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.AlertsApi()
alert_id = 56 # int | The ID of the alert the custom compliance controls belong to
include = 'include_example' # str | 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 = '{:number=>1,+:size=>20}' # str | 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})

try: 
    # Get a list of Custom Compliance Controls for an Alert
    api_response = api_instance.list_custom_compliance_controls(alert_id, include=include, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->list_custom_compliance_controls: %s\n" % e)

Parameters

Name Type Description Notes
alert_id int The ID of the alert the custom compliance controls belong to
include str 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 str 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

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_for_report

PaginatedCollection list_for_report(report_id, include=include, filter=filter, page=page)

Get a list of Alerts for a Report

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.AlertsApi()
report_id = 56 # int | ID of the Report to Return Alerts For
include = 'include_example' # str | 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 = {'key': 'filter_example'} # dict(str, str) | 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 = '{:number=>1,+:size=>20}' # str | 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})

try: 
    # Get a list of Alerts for a Report
    api_response = api_instance.list_for_report(report_id, include=include, filter=filter, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->list_for_report: %s\n" % e)

Parameters

Name Type Description Notes
report_id int ID of the Report to Return Alerts For
include str 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 dict(str, str) 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 str 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

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show

Alert show(id, include=include)

Show a single Alert

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.AlertsApi()
id = 56 # int | Alert ID
include = 'include_example' # str | 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)

try: 
    # Show a single Alert
    api_response = api_instance.show(id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->show: %s\n" % e)

Parameters

Name Type Description Notes
id int Alert ID
include str 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

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]