The Evident Security Platform API (version 2.0) is designed to allow users granular control over their Amazon Web Service security experience by allowing them to review alerts, monitor signatures, and create custom signatures.
This Python package is automatically generated by the Swagger Codegen project:
- API version: v2_sdk
- Package version: 1.0.0.rc1
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
pip install esp_sdkOr you can install directly from Github
pip install git+https://github.com/EvidentSecurity/esp-sdk-python.git(you may need to run pip with root permission: sudo pip install git+https://github.com/EvidentSecurity/esp-sdk-python.git)
Then import the package:
import esp_sdkInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import esp_sdkYou must set your access_key_id and your secret_access_key. You can set these directly:
config = esp_sdk.Configuration()
config.access_key_id = '<your key>'
config.secret_access_key = '<your secret key>'or with environment variables:
os.environ['ESP_ACCESS_KEY_ID'] = '<your key>'
os.environ['ESP_SECRET_ACCESS_KEY'] = '<your secret key>'Get your HMAC keys from the Evident.io website, esp.evident.io
Users of Evident.io's AWS marketplace PSAAS/appliance will need to set the host for their appliance instance. You can set this directly:
config = esp_sdk.Configuration().host = '<host for appliance instance>'The host needs to include the scheme. Example: config.host = 'https://api.evident.io' This is the default.
Alternatively, the site can also be set with an environment variable.
export ESP_HOST=<host for appliance instance>
Please follow the installation procedure and then run the following:
from __future__ import print_function
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.APIKeysApi()
include = 'include_example' # str | Related objects that can be included in the response: user See Including Objects for more information. (optional)
name = 'name_example' # str | The name of the API Key (optional)
try:
# Create a(n) API Key
api_response = api_instance.create(include=include, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling APIKeysApi->create: %s\n" % e)
The response objects have an errors collection. If the API call returns a non fatal response, like validation issues, you can check the errors object to see what went wrong.
> t = esp_sdk.TeamsApi().create(1, '')
# => t.errors = ["Name can't be blank"]When an error is thrown, you can rescue the error and check the error message:
> c = esp_sdk.SignaturesApi().run(1, 9999, 'us-east-1')
# => esp_sdk.rest.ApiException: (404)
# => Reason: Failed. Response code = 404. Response message = Couldn't find ExternalAccountEvident.io API endpoints that return a collection of objects allows for paging and only returns a limited number of items at a time. The Evident.io SDK returns an esp_sdk.PaginatedCollection object that provides methods for paginating through the collection.
> alerts = esp_sdk.AlertsApi().list(345)
> alerts.current_page_number # => "1"
> page2 = alerts.next_page()
> alerts.current_page_number # => "1"
> page2.current_page_number # => "2"
> page1 = page2.previous_page()
> page1.current_page_number # => "1"
> last_page = alerts.last_page()
> last_page.current_page_number # => "25"
> page4 = alerts.page(4)
> page4.current_page_number # => "4"The __iter__ function on esp_sdk.PaginatedCollection allows you to iterate through the entire
collection, making additional API calls to get the next page, until it is on the last page.
> alerts = esp_sdk.AlertsApi().list(345)
> [a.id for a in alerts]See esp_sdk.PaginatedCollection for all the pagination methods available.
Most of the objects in the Evident.io SDK have a corresponding API call associated with it. That means if you want an object's associated object, then you will make another API call using the associated objects api. For example:
> external_account = esp_sdk.ExternalAccountsApi().show(3)
> organization = esp_sdk.OrganizationsApi().show(external_account.organization_id)
> sub_organization = esp_sdk.SubOrganizationsApi().show(external_account.sub_organization_id)
> team = esp_sdk.TeamsApi().show(external_account.team_id)The above code will make 4 calls to the Evident.io API. 1 each for the external account, organization, sub_organization and team. The JSON API Specification, which the Evident.io API tries to follow, provides a means for returning nested objects in a single call. With the SDK, that can be done by providing a comma separated string of the relations wanted in an +include+ option.
> external_account = esp_sdk.ExternalAccountsApi().show(3, include='organization,sub_orgnanization,team')> external_account = esp_sdk::ExternalAccountsApi().list(id_eq: 3, include='organization,sub_organization,team')With that call, organization, sub_organization and team will all come back in the response, and calling, external_account.organization,
external_account.sub_organization and external_account.team will return the associated object.
You can nest include requests with the dot property. For example, requesting external_account.team on an alert will expand the external_account property into a full External Account object, and will then expand the team property on that external account into a full Team object.
Deep nesting is available as well: external_account.team.sub_organization.organization
alert = esp_sdk.AlertsApi().show(1, include='tags,external_account.team')
alerts = esp_sdk.AlertsApi().list(4, include='tags,external_account.team')Most objects' show and list methods accept the +include+ option. Those methods that accept the +include+ option are documented with the available associations that are includable.
For objects that implement list, parameters can be passed that will filter the results based on the search criteria specified.
The criteria that can be specified depends on the object. Each object is documented whether it implements list or not,
and if so, which attributes can be included in the search criteria.
The primary method of searching is by using what is known as predicates.
Predicates are used within Evident.io API search queries to determine what information to
match. For instance, the cont predicate, when added to the name attribute, will check to see if `name`` contains a value using a wildcard query.
esp_sdk.SignaturesApi().list(filter={ "name_cont": 'dns' })
#=> will return signatures `where name LIKE '%dns%'`The syntax for queries on an associated relationship is to just append the association name to the attribute:
esp_sdk.SuppressionsApi().list(filter={ "regions_code_eq": 'us_east_1' })
#=> will return suppressions that have a region relationship `where code = 'us_east_1'`Add multiple attributes and predicates to form complex queries:
esp_sdk.SuppressionsApi().list(filter={ "regions_code_start": 'us', "created_by_email_eq": '[email protected]', resource_not_null: '1' })
#=> will return suppressions that have a region relationship `where code LIKE 'us%'` and created_by relationship `where email = '[email protected]'` and `resource IS NOT NULL`You can also change the combinator for complex queries from the default AND to OR by adding the m: 'or' parameter
esp_sdk.SuppressionsApi().list(filter={ "regions_code_start": 'us', "created_by_email_eq": '[email protected]', resource_not_null: '1', m: 'or' })
#=> will return suppressions that have a region relationship `where code LIKE 'us%'` **OR** created_by relationship `where email = '[email protected]'` **OR** `resource IS NOT NULL`Please note: any attempt to use a predicate for an attribute that does not exist will return a 422 (Unprocessable Entity) response. For instance, this will not work:
esp_sdk.SuppressionsApi().list(filter={ "bad_attribute_eq": 'something' })
#=> esp_sdk.ApiError()iled. Response code = 422. Response message = Invalid search term bad_attribute_eq.Also note: any attempt to use a predicate for an attribute that exists on the object, but is not a documented searchable attribute will silently fail and will be excluded from the search criteria.
Below is a list of the available predicates and their opposites.
The eq predicate returns all records where a field is exactly equal to a given value:
esp_sdk.SuppressionsApi().list(filter={ "regions_code_eq": 'us_east_1' })
#=> will return suppressions that have a region relationship `where code = 'us_east_1'`Opposite: not_eq
The lt predicate returns all records where a field is less than a given value:
from datetime import datetime, timedelta
esp_sdk.ReportsApi().list(filter={ "created_at_lt": datetime.now() - timedelta(hours = 1) })
#=> will return reports `where created_at < '2015-11-11 16:25:30'`Opposite: gt (greater than)
The lteq predicate returns all records where a field is less than or equal to a given value:
from datetime import datetime, timedelta
esp_sdk.ReportsApi().list(filter={ "created_at_lteq": datetime.now() - timedelta(hours = 1) })
#=> will return reports `where created_at <= '2015-11-11 16:25:30'`Opposite: gteq (greater than or equal to)
The in predicate returns all records where a field is within a specified list:
esp_sdk.SignaturesApi().list(filter={ "risk_level_in": ['Low', 'Medium'] })
#=> will return signatures `where risk_level IN ('Low', 'Medium')`Opposite: not_in
The cont predicate returns all records where a field contains a given value:
esp_sdk.SignaturesApi().list(filter={ "name_cont": 'dns' })
#=> will return signatures `where name LIKE '%dns%'`Opposite: not_cont
Please note: This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
for each implemented where method.
The cont_any predicate returns all records where a field contains any of given values:
esp_sdk.SignaturesApi().list(filter={ "name_cont_any": ['dns', 'EC2'] })
#=> will return signatures `where name LIKE '%dns%' or name LIKE '%EC2%'`Opposite: not_cont_any
Please note: This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
for each implemented where method.
The start predicate returns all records where a field begins with a given value:
esp_sdk.SignaturesApi().list(filter={ "name_start": 'dns' })
#=> will return signatures `where name LIKE 'dns%'`Opposite: not_start
Please note: This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
for each implemented where method.
The end predicate returns all records where a field ends with a given value:
esp_sdk.SignaturesApi().list(filter={ "name_end": 'dns' })
#=> will return signatures `where name LIKE '%dns'`Opposite: not_end
Please note: This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
for each implemented where method.
The present predicate returns all records where a field is present (not null and not a
blank string).
esp_sdk.SignaturesApi().list(filter={ "identifier_present": '1' })
#=> will return signatures `where identifier IS NOT NULL AND identifier != ''`Opposite: blank
The null predicate returns all records where a field is null:
esp_sdk.SignaturesApi().list(filter={ "identifier_null": 1 })
#=> will return signatures `where identifier IS NULL`Opposite: not_null
Lists can also be sorted by adding the sorts parameter with the field to sort by to the filter parameter.
esp_sdk.SignaturesApi().list(filter={ "name_cont": 'dns', "sorts": 'risk_level desc' })
#=> will return signatures `where name LIKE '%dns%'` sorted by `risk_level` in descending order.Lists can be sorted by multiple fields by specifying an ordered array.
esp_sdk.SignaturesApi().list(filter={ "name_cont": 'dns', "sorts": ['risk_level desc', 'created_at'] })
#=> will return signatures `where name LIKE '%dns%'` sorted by `risk_level` in descending order and then by `created_at` in ascending order.All URIs are relative to https://api.evident.io/
The description of the filter parameter for the list endpoints have the searchable attributes separated into different lists.
These attributes can be used with predicates that look for an exact match such as eq
These attributes can be used with predicates that look for a string that matches the supplied string such as cont
These attributes cannot be used with every predicate. Only with the predicates listed.
These are associations you can search through. See the documentation for each association to see which attributes are searchable.
These attributes can be passed with the sorts key to sort the response.
| Class | Method | HTTP request | Description |
|---|---|---|---|
| APIKeysApi | create | POST /api/v2/api_keys.json_api | Create a(n) API Key |
| APIKeysApi | delete | DELETE /api/v2/api_keys/{id}.json_api | Delete a(n) API Key |
| APIKeysApi | list | GET /api/v2/api_keys.json_api | Get a list of API Keys |
| APIKeysApi | show | GET /api/v2/api_keys/{id}.json_api | Show a single API Key |
| APIKeysApi | update | PATCH /api/v2/api_keys/{id}.json_api | Update a(n) API Key |
| AlertsApi | list_compliance_controls | GET /api/v2/alerts/{alert_id}/compliance_controls.json_api | Get a list of Compliance Controls for an Alert |
| AlertsApi | 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 |
| AlertsApi | list_for_report | PUT /api/v2/reports/{report_id}/alerts.json_api | Get a list of Alerts for a Report |
| AlertsApi | show | GET /api/v2/alerts/{id}.json_api | Show a single Alert |
| AttributionApi | show | GET /api/v2/alerts/{alert_id}/attribution.json_api | Show the attribution for an alert |
| AuditLogExportApi | request_file | POST /api/v2/audit_logs/export/files.json_api | Export an Audit Log File |
| AuditLogExportApi | show_file_details | GET /api/v2/audit_logs/export/files/{id}.json_api | Show a single Audit Log File |
| AuditLogsApi | list | PUT /api/v2/audit_logs.json_api | Get a list of Audit Logs |
| AuditLogsApi | show | GET /api/v2/audit_logs/{id}.json_api | Show a single Audit Log |
| AzureGroupsApi | add_external_account | POST /api/v2/azure_groups/{azure_group_id}/memberships.json_api | Add an External Account to an Azure Group |
| AzureGroupsApi | create | POST /api/v2/azure_groups.json_api | Create a(n) Azure Group |
| AzureGroupsApi | delete | DELETE /api/v2/azure_groups/{id}.json_api | Delete a(n) Azure Group |
| AzureGroupsApi | list | PUT /api/v2/azure_groups.json_api | Get a list of Azure Groups |
| AzureGroupsApi | remove_external_account | DELETE /api/v2/azure_groups/{azure_group_id}/memberships/{external_account_id}.json_api | Remove an External Account from an Azure Group |
| AzureGroupsApi | show | GET /api/v2/azure_groups/{id}.json_api | Show a single Azure Group |
| AzureGroupsApi | update | PATCH /api/v2/azure_groups/{id}.json_api | Update a(n) Azure Group |
| ComplianceControlsApi | list | PUT /api/v2/compliance_controls.json_api | Get a list of Compliance Controls |
| ComplianceControlsApi | list_signatures | GET /api/v2/compliance_controls/{compliance_control_id}/signatures.json_api | Get a list of Signatures for a Compliance Control |
| ComplianceControlsApi | show | GET /api/v2/compliance_controls/{id}.json_api | Show a single Compliance Control |
| ComplianceDomainsApi | list | PUT /api/v2/compliance_domains.json_api | Get a list of Compliance Domains |
| ComplianceDomainsApi | show | GET /api/v2/compliance_domains/{id}.json_api | Show a single Compliance Domain |
| ComplianceStandardsApi | list | PUT /api/v2/compliance_standards.json_api | Get a list of Compliance Standards |
| ComplianceStandardsApi | show | GET /api/v2/compliance_standards/{id}.json_api | Show a single Compliance Standard |
| CustomComplianceControlsApi | add_custom_signature | POST /api/v2/custom_compliance_controls/{custom_compliance_control_id}/custom_signatures.json_api | Add a Custom Signature to a Custom Compliance Control |
| CustomComplianceControlsApi | add_signature | POST /api/v2/custom_compliance_controls/{custom_compliance_control_id}/signatures.json_api | Add a Signature to a Custom Compliance Control |
| CustomComplianceControlsApi | create | POST /api/v2/custom_compliance_controls.json_api | Create a(n) Custom Compliance Control |
| CustomComplianceControlsApi | delete | DELETE /api/v2/custom_compliance_controls/{id}.json_api | Delete a(n) Custom Compliance Control |
| CustomComplianceControlsApi | list_custom_signatures | GET /api/v2/custom_compliance_controls/{custom_compliance_control_id}/custom_signatures.json_api | Get a list of Custom Signatures for a Custom Compliance Control |
| CustomComplianceControlsApi | list_signatures | GET /api/v2/custom_compliance_controls/{custom_compliance_control_id}/signatures.json_api | Get a list of Signatures for a Custom Compliance Control |
| CustomComplianceControlsApi | remove_custom_signature | DELETE /api/v2/custom_compliance_controls/{custom_compliance_control_id}/custom_signatures/{custom_signature_id}.json_api | Remove a Custom Signature from a Custom Compliance Control |
| CustomComplianceControlsApi | remove_signature | DELETE /api/v2/custom_compliance_controls/{custom_compliance_control_id}/signatures/{signature_id}.json_api | Remove a Signature from a Custom Compliance Control |
| CustomComplianceControlsApi | show | GET /api/v2/custom_compliance_controls/{id}.json_api | Show a single Custom Compliance Control |
| CustomComplianceControlsApi | update | PATCH /api/v2/custom_compliance_controls/{id}.json_api | Update a(n) Custom Compliance Control |
| CustomComplianceDomainsApi | create | POST /api/v2/custom_compliance_domains.json_api | Create a(n) Custom Compliance Domain |
| CustomComplianceDomainsApi | delete | DELETE /api/v2/custom_compliance_domains/{id}.json_api | Delete a(n) Custom Compliance Domain |
| CustomComplianceDomainsApi | show | GET /api/v2/custom_compliance_domains/{id}.json_api | Show a single Custom Compliance Domain |
| CustomComplianceDomainsApi | update | PATCH /api/v2/custom_compliance_domains/{id}.json_api | Update a(n) Custom Compliance Domain |
| CustomComplianceStandardsApi | create | POST /api/v2/custom_compliance_standards.json_api | Create a(n) Custom Compliance Standard |
| CustomComplianceStandardsApi | delete | DELETE /api/v2/custom_compliance_standards/{id}.json_api | Delete a(n) Custom Compliance Standard |
| CustomComplianceStandardsApi | show | GET /api/v2/custom_compliance_standards/{id}.json_api | Show a single Custom Compliance Standard |
| CustomComplianceStandardsApi | update | PATCH /api/v2/custom_compliance_standards/{id}.json_api | Update a(n) Custom Compliance Standard |
| CustomSignatureDefinitionsApi | activate | PATCH /api/v2/custom_signature_definitions/{custom_signature_definition_id}/activate.json_api | Activate a Custom Signature Definition |
| CustomSignatureDefinitionsApi | archive | PATCH /api/v2/custom_signature_definitions/{custom_signature_definition_id}/archive.json_api | Archive a Custom Signature Definition |
| CustomSignatureDefinitionsApi | create | POST /api/v2/custom_signature_definitions.json_api | Create a(n) Custom Signature Definition |
| CustomSignatureDefinitionsApi | delete | DELETE /api/v2/custom_signature_definitions/{id}.json_api | Delete a(n) Custom Signature Definition |
| CustomSignatureDefinitionsApi | list | PUT /api/v2/custom_signature_definitions.json_api | Get a list of Custom Signature Definitions |
| CustomSignatureDefinitionsApi | show | GET /api/v2/custom_signature_definitions/{id}.json_api | Show a single Custom Signature Definition |
| CustomSignatureDefinitionsApi | update | PATCH /api/v2/custom_signature_definitions/{id}.json_api | Update a(n) Custom Signature Definition |
| CustomSignatureResultsApi | create | POST /api/v2/custom_signature_results.json_api | Create a(n) Custom Signature Result |
| CustomSignatureResultsApi | list | PUT /api/v2/custom_signature_results.json_api | Get a list of Custom Signature Results |
| CustomSignatureResultsApi | list_alerts | GET /api/v2/custom_signature_results/{custom_signature_result_id}/alerts.json_api | Returns the Alerts for a given Custom Signature Result |
| CustomSignatureResultsApi | show | GET /api/v2/custom_signature_results/{id}.json_api | Show a single Custom Signature Result |
| CustomSignaturesApi | create | POST /api/v2/custom_signatures.json_api | Create a(n) Custom Signature |
| CustomSignaturesApi | delete | DELETE /api/v2/custom_signatures/{id}.json_api | Delete a(n) Custom Signature |
| CustomSignaturesApi | list | PUT /api/v2/custom_signatures.json_api | Get a list of Custom Signatures |
| CustomSignaturesApi | show | GET /api/v2/custom_signatures/{id}.json_api | Show a single Custom Signature |
| CustomSignaturesApi | update | PATCH /api/v2/custom_signatures/{id}.json_api | Update a(n) Custom Signature |
| ExternalAccountsApi | add_compliance_standard | POST /api/v2/external_accounts/{external_account_id}/compliance_standards.json_api | Add a compliance standard to an external account |
| ExternalAccountsApi | add_custom_compliance_standard | POST /api/v2/external_accounts/{external_account_id}/custom_compliance_standards.json_api | Add a custom compliance standard to an external account |
| ExternalAccountsApi | add_disabled_signature | POST /api/v2/external_accounts/disabled_signatures.json_api | Disable a set of signatures for an external account or a set of external accounts for a signature |
| ExternalAccountsApi | delete | DELETE /api/v2/external_accounts/{id}.json_api | Delete a(n) External Account |
| ExternalAccountsApi | list | PUT /api/v2/external_accounts.json_api | Get a list of External Accounts |
| ExternalAccountsApi | list_compliance_standards | GET /api/v2/external_accounts/{external_account_id}/compliance_standards.json_api | Get a list of compliance standards for an external account |
| ExternalAccountsApi | list_custom_compliance_standards | GET /api/v2/external_accounts/{external_account_id}/custom_compliance_standards.json_api | Get a list of custom compliance standards for an external account |
| ExternalAccountsApi | list_disabled_signatures | PUT /api/v2/external_accounts/{external_account_id}/disabled_signatures.json_api | Get a list all the disabled signatures for an external account |
| ExternalAccountsApi | remove_compliance_standard | DELETE /api/v2/external_accounts/{external_account_id}/compliance_standards/{compliance_standard_id}.json_api | Remove a compliance standard from an external account |
| ExternalAccountsApi | remove_custom_compliance_standard | DELETE /api/v2/external_accounts/{external_account_id}/custom_compliance_standards/{custom_compliance_standard_id}.json_api | Remove a custom compliance standard from an external account |
| ExternalAccountsApi | remove_disabled_signature | DELETE /api/v2/external_accounts/disabled_signatures.json_api | Re-enable a set of signatures for an external account or a set of external accounts for a signature |
| ExternalAccountsApi | show | GET /api/v2/external_accounts/{id}.json_api | Show a single External Account |
| ExternalAccountsAmazonApi | create | POST /api/v2/external_accounts/amazon.json_api | Create an Amazon External Account |
| ExternalAccountsAmazonApi | show | GET /api/v2/external_accounts/{external_account_id}/amazon.json_api | Show an Amazon External Account |
| ExternalAccountsAmazonApi | update | PATCH /api/v2/external_accounts/{external_account_id}/amazon.json_api | Update an Amazon External Account |
| ExternalAccountsAzureApi | create | POST /api/v2/external_accounts/azure.json_api | Create an Azure External Account |
| ExternalAccountsAzureApi | reset_url | PATCH /api/v2/external_accounts/{external_account_id}/azure/log_url.json_api | Reset Log URL for an Azure External Account |
| ExternalAccountsAzureApi | show | GET /api/v2/external_accounts/{external_account_id}/azure.json_api | Show an Azure External Account |
| ExternalAccountsAzureApi | update | PATCH /api/v2/external_accounts/{external_account_id}/azure.json_api | Update an Azure External Account |
| IntegrationsApi | delete | DELETE /api/v2/integrations/{id}.json_api | Delete a(n) Integration |
| IntegrationsApi | disable | PATCH /api/v2/integrations/{id}/disable.json_api | Disable a single Integration |
| IntegrationsApi | list | PUT /api/v2/integrations.json_api | Get a list of Integrations |
| IntegrationsApi | show | GET /api/v2/integrations/{id}.json_api | Show a single Integration |
| IntegrationsApi | test_notify | POST /api/v2/integrations/{id}/test_notify.json_api | Test an Integration |
| IntegrationsAmazonSNSApi | create | POST /api/v2/integrations/amazon_sns.json_api | Create an Amazon SNS Integration |
| IntegrationsAmazonSNSApi | show | GET /api/v2/integrations/{integration_id}/amazon_sns.json_api | Show a single Amazon SNS Integration |
| IntegrationsAmazonSNSApi | update | PATCH /api/v2/integrations/{integration_id}/amazon_sns.json_api | Update an Amazon SNS Integration |
| IntegrationsHipchatApi | create | POST /api/v2/integrations/hipchat.json_api | Create a Hipchat Integration |
| IntegrationsHipchatApi | show | GET /api/v2/integrations/{integration_id}/hipchat.json_api | Show a single Hipchat Integration |
| IntegrationsHipchatApi | update | PATCH /api/v2/integrations/{integration_id}/hipchat.json_api | Update a Hipchat Integration |
| IntegrationsJiraApi | create | POST /api/v2/integrations/jira.json_api | Create a JIRA Integration |
| IntegrationsJiraApi | show | GET /api/v2/integrations/{integration_id}/jira.json_api | Show a single Jira Integration |
| IntegrationsJiraApi | update | PATCH /api/v2/integrations/{integration_id}/jira.json_api | Update a JIRA Integration |
| IntegrationsPagerDutyApi | create | POST /api/v2/integrations/pager_duty.json_api | Create a Pager Duty Integration |
| IntegrationsPagerDutyApi | show | GET /api/v2/integrations/{integration_id}/pager_duty.json_api | Show a single Pager Duty Integration |
| IntegrationsPagerDutyApi | update | PATCH /api/v2/integrations/{integration_id}/pager_duty.json_api | Update a Pager Duty Integration |
| IntegrationsServiceNowApi | create | POST /api/v2/integrations/servicenow.json_api | Create a ServiceNow Integration |
| IntegrationsServiceNowApi | show | GET /api/v2/integrations/{integration_id}/servicenow.json_api | Show a single ServiceNow Integration |
| IntegrationsServiceNowApi | update | PATCH /api/v2/integrations/{integration_id}/servicenow.json_api | Update a ServiceNow Integration |
| IntegrationsSlackApi | create | POST /api/v2/integrations/slack.json_api | Create a Slack Integration |
| IntegrationsSlackApi | show | GET /api/v2/integrations/{integration_id}/slack.json_api | Show a single Slack Integration |
| IntegrationsSlackApi | update | PATCH /api/v2/integrations/{integration_id}/slack.json_api | Update a Slack Integration |
| IntegrationsWebhookApi | create | POST /api/v2/integrations/webhook.json_api | Create a Webhook Integration |
| IntegrationsWebhookApi | show | GET /api/v2/integrations/{integration_id}/webhook.json_api | Show a single Webhook Integration |
| IntegrationsWebhookApi | update | PATCH /api/v2/integrations/{integration_id}/webhook.json_api | Update a Webhook Integration |
| MetadataApi | for_alert | GET /api/v2/alerts/{alert_id}/metadata.json_api | Show the metadata for an alert |
| MetadataApi | show | GET /api/v2/metadata/{id}.json_api | Show a single Metadata |
| OrganizationsApi | list | PUT /api/v2/organizations.json_api | Get a list of Organizations |
| OrganizationsApi | list_compliance_standards | GET /api/v2/organizations/{organization_id}/compliance_standards.json_api | Get a list of compliance standards for an organization |
| OrganizationsApi | show | GET /api/v2/organizations/{id}.json_api | Show a single Organization |
| OrganizationsApi | update | PATCH /api/v2/organizations/{id}.json_api | Update a(n) Organization |
| PlansApi | list | GET /api/v2/plans.json_api | Get a list of Plans |
| PlansApi | show | GET /api/v2/plans/{id}.json_api | Show a single Plan |
| RegionsApi | list | PUT /api/v2/regions.json_api | Get a list of Regions |
| RegionsApi | show | GET /api/v2/regions/{id}.json_api | Show a single Region |
| ReportExportApi | request_file | POST /api/v2/reports/export/files.json_api | Export all alerts for a set of reports to a file |
| ReportExportApi | send_to_integration | POST /api/v2/reports/export/integrations.json_api | Export all alerts on reports to an integration |
| ReportExportApi | show_file_details | GET /api/v2/reports/export/files/{id}.json_api | Show a single Exported Report |
| ReportsApi | create | POST /api/v2/reports.json_api | Create a(n) Report |
| ReportsApi | list | PUT /api/v2/reports.json_api | Get a list of Reports |
| ReportsApi | show | GET /api/v2/reports/{id}.json_api | Show a single Report |
| RolesApi | list | GET /api/v2/roles.json_api | Get a list of Roles |
| RolesApi | show | GET /api/v2/roles/{id}.json_api | Show a single Role |
| ScanIntervalsApi | create | POST /api/v2/scan_intervals.json_api | Create a(n) Scan Interval |
| ScanIntervalsApi | delete | DELETE /api/v2/scan_intervals/{id}.json_api | Delete a(n) Scan Interval |
| ScanIntervalsApi | list_for_external_account | GET /api/v2/external_accounts/{external_account_id}/scan_intervals.json_api | Get a list of Scan Intervals |
| ScanIntervalsApi | show | GET /api/v2/scan_intervals/{id}.json_api | Show a single Scan Interval |
| ScanIntervalsApi | update | PATCH /api/v2/scan_intervals/{id}.json_api | Update a(n) Scan Interval |
| ScheduledExportsApi | activate_export | PATCH /api/v2/scheduled_exports/{scheduled_export_id}/activate.json_api | Update a(n) Scheduled Export |
| ScheduledExportsApi | create | POST /api/v2/scheduled_exports.json_api | Create a(n) Scheduled Export |
| ScheduledExportsApi | delete | DELETE /api/v2/scheduled_exports/{id}.json_api | Delete a(n) Scheduled Export |
| ScheduledExportsApi | disable_export | PATCH /api/v2/scheduled_exports/{scheduled_export_id}/disable.json_api | Update a(n) Scheduled Export |
| ScheduledExportsApi | list | PUT /api/v2/scheduled_exports.json_api | Get a list of Scheduled Exports |
| ScheduledExportsApi | show | GET /api/v2/scheduled_exports/{id}.json_api | Show a single Scheduled Export |
| ScheduledExportsApi | show_file_details | GET /api/v2/reports/scheduled_export/files/{uuid}.json_api | Show a single Scheduled Export Result |
| ScheduledExportsApi | unsubscribe_export | PATCH /api/v2/scheduled_exports/{uuid}/unsubscribe.json_api | Update a(n) Scheduled Export |
| ScheduledExportsApi | update | PATCH /api/v2/scheduled_exports/{id}.json_api | Update a(n) Scheduled Export |
| ServicesApi | list | PUT /api/v2/services.json_api | Get a list of Services |
| ServicesApi | show | GET /api/v2/services/{id}.json_api | Show a single Service |
| SignaturesApi | list | PUT /api/v2/signatures.json_api | Get a list of Signatures |
| SignaturesApi | list_disabled_external_accounts | GET /api/v2/signatures/{signature_id}/disabled_external_accounts.json_api | Get a list of disabled External Accounts for a signature |
| SignaturesApi | list_with_custom_risk_level_for_external_account | PUT /api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels.json_api | Get A list of Signatures with default and custom risk levels for an External Account |
| SignaturesApi | remove_custom_risk_level_for_external_account | DELETE /api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels/{signature_id}.json_api | Remove a custom risk level to a Signature for an External Account |
| SignaturesApi | set_custom_risk_level_for_external_account | POST /api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels.json_api | Add a custom risk level to a Signature for an External Account |
| SignaturesApi | show | GET /api/v2/signatures/{id}.json_api | Show a single Signature |
| SignaturesApi | update_custom_risk_level_for_external_account | PATCH /api/v2/external_accounts/{external_account_id}/signature_custom_risk_levels/{signature_id}.json_api | Update a Signature's custom risk level for an External Account |
| StatComplianceControlsApi | list_for_stat | GET /api/v2/stats/{stat_id}/compliance_controls.json_api | Statistics for compliance controls |
| StatComplianceControlsApi | show | GET /api/v2/stats/compliance_controls/{id}.json_api | Show a single Stat Compliance Control |
| StatCustomComplianceControlsApi | list_for_stat | GET /api/v2/stats/{stat_id}/custom_compliance_controls.json_api | Statistics for custom compliance controls |
| StatCustomComplianceControlsApi | show | GET /api/v2/stats/custom_compliance_controls/{id}.json_api | Show a single Stat Custom Compliance Control |
| StatCustomSignaturesApi | list_for_stat | GET /api/v2/stats/{stat_id}/custom_signatures.json_api | Statistics for custom signatures |
| StatCustomSignaturesApi | show | GET /api/v2/stats/custom_signatures/{id}.json_api | Show a single Stat Custom Signature |
| StatRegionsApi | list_for_stat | GET /api/v2/stats/{stat_id}/regions.json_api | Get a list of statistics for regions |
| StatRegionsApi | show | GET /api/v2/stats/regions/{id}.json_api | Show a single Stat Region |
| StatServicesApi | list_for_stat | GET /api/v2/stats/{stat_id}/services.json_api | Get a list of statistics for services |
| StatServicesApi | show | GET /api/v2/stats/services/{id}.json_api | Show a single Stat Service |
| StatSignaturesApi | list_for_stat | GET /api/v2/stats/{stat_id}/signatures.json_api | Get a list of statistics for signatures |
| StatSignaturesApi | show | GET /api/v2/stats/signatures/{id}.json_api | Show a single Stat Signature |
| StatsApi | for_report | GET /api/v2/reports/{report_id}/stats.json_api | Stats for a report |
| StatsApi | latest_for_teams | PUT /api/v2/stats/latest_for_teams.json_api | Statistics for teams |
| StatsApi | show | GET /api/v2/stats/{id}.json_api | Show a single Stat |
| SubOrganizationsApi | create | POST /api/v2/sub_organizations.json_api | Create a(n) Sub Organization |
| SubOrganizationsApi | delete | DELETE /api/v2/sub_organizations/{id}.json_api | Delete a(n) Sub Organization |
| SubOrganizationsApi | list | PUT /api/v2/sub_organizations.json_api | Get a list of Sub Organizations |
| SubOrganizationsApi | show | GET /api/v2/sub_organizations/{id}.json_api | Show a single Sub Organization |
| SubOrganizationsApi | update | PATCH /api/v2/sub_organizations/{id}.json_api | Update a(n) Sub Organization |
| SubscriptionsApi | show | GET /api/v2/subscriptions/{id}.json_api | Show a single Subscription |
| SuppressionsApi | create | POST /api/v2/suppressions.json_api | Create a suppression |
| SuppressionsApi | create_from_alert | POST /api/v2/suppressions/alerts.json_api | Creates a suppression from an alert |
| SuppressionsApi | deactivate | PATCH /api/v2/suppressions/{id}/deactivate.json_api | Deactivate a suppression |
| SuppressionsApi | list | PUT /api/v2/suppressions.json_api | Get a list of Suppressions |
| SuppressionsApi | show | GET /api/v2/suppressions/{id}.json_api | Show a single Suppression |
| SuppressionsApi | update | PATCH /api/v2/suppressions/{id}.json_api | Update a(n) Suppression |
| TagsApi | list_for_alert | GET /api/v2/alerts/{alert_id}/tags.json_api | Get a list of Tags |
| TagsApi | show | GET /api/v2/tags/{id}.json_api | Show a single Tag |
| TeamsApi | create | POST /api/v2/teams.json_api | Create a(n) Team |
| TeamsApi | delete | DELETE /api/v2/teams/{id}.json_api | Delete a(n) Team |
| TeamsApi | list | PUT /api/v2/teams.json_api | Get a list of Teams |
| TeamsApi | show | GET /api/v2/teams/{id}.json_api | Show a single Team |
| TeamsApi | update | PATCH /api/v2/teams/{id}.json_api | Update a(n) Team |
| UserAttributionsApi | add_channel | POST /api/v2/external_accounts/{external_account_id}/user_attribution/channel.json_api | Create a User Attribution Channel for an external account |
| UserAttributionsApi | remove_channel | DELETE /api/v2/external_accounts/{external_account_id}/user_attribution/channel.json_api | Remove the User Attribution Channel for an external account |
| UserAttributionsApi | show_channel | GET /api/v2/external_accounts/{external_account_id}/user_attribution/channel.json_api | Show the User Attribution Channel of an external account |
| UserAttributionsApi | update | PATCH /api/v2/external_accounts/{external_account_id}/user_attribution.json_api | Update the user attributions on an external account |
| UsersApi | create | POST /api/v2/users.json_api | Create a(n) User |
| UsersApi | delete | DELETE /api/v2/users/{id}.json_api | Delete a(n) User |
| UsersApi | list | PUT /api/v2/users.json_api | Get a list of Users |
| UsersApi | show | GET /api/v2/users/{id}.json_api | Show a single User |
| UsersApi | update | PATCH /api/v2/users/{id}.json_api | Update a(n) User |
- Alert
- ApiKey
- Attribution
- AuditLog
- AuditLogFile
- AzureGroup
- ComplianceControl
- ComplianceDomain
- ComplianceStandard
- CustomComplianceControl
- CustomComplianceDomain
- CustomComplianceStandard
- CustomSignature
- CustomSignatureDefinition
- CustomSignatureResult
- CustomSignatureResultAlert
- ExportedReport
- ExternalAccount
- ExternalAccountAmazonIam
- ExternalAccountAzure
- ExternalAccountUserAttributionChannel
- Integration
- IntegrationAmazonSns
- IntegrationHipchat
- IntegrationJira
- IntegrationPagerDuty
- IntegrationServicenow
- IntegrationSlack
- IntegrationWebhook
- Meta
- Metadata
- Organization
- PaginatedCollection
- Plan
- Region
- Report
- Role
- ScanInterval
- ScheduledExport
- ScheduledExportResult
- Service
- Signature
- Stat
- StatComplianceControl
- StatCustomComplianceControl
- StatCustomSignature
- StatRegion
- StatService
- StatSignature
- SubOrganization
- Subscription
- Suppression
- Tag
- Team
- User