Skip to content

Latest commit

 

History

History
195 lines (149 loc) · 14.3 KB

README.md

File metadata and controls

195 lines (149 loc) · 14.3 KB
Raw

thousandeyes-sdk-alerts

You can manage the following alert functionalities on the ThousandEyes platform using the Alerts API:

  • Alerts: Retrieve alert details. Alerts are assigned to tests through alert rules.

  • Alert Rules: Conditions that you configure in order to highlight or be notified of events of interest in your ThousandEyes tests. When an alert rule’s conditions are met, the associated alert is triggered and the alert becomes active. It remains active until the alert is cleared. Alert rules are reusable across multiple tests..

  • Alert Suppression Windows: Suppress alerts for tests during periods such as planned maintenance. Windows can be one-time events or recurring events to handle periodic occurrences such as monthly downtime for maintenance.

For more information about the alerts, see Alerts.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 7.0.32
  • Generator version: 7.6.0
  • Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.8+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-alerts

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-alerts)

Then import the package:

import thousandeyes_sdk.alerts

Setuptools

Install 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 thousandeyes_sdk.alerts

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.alerts
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com/v7"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.alerts.AlertRulesApi(api_client)
    rule_detail_update = thousandeyes_sdk.alerts.RuleDetailUpdate() # RuleDetailUpdate | 
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # Create alert rule
        api_response = api_instance.create_alert_rule(rule_detail_update, aid=aid)
        print("The response of AlertRulesApi->create_alert_rule:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlertRulesApi->create_alert_rule: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class Method HTTP request Description
AlertRulesApi create_alert_rule POST /alerts/rules Create alert rule
AlertRulesApi delete_alert_rule DELETE /alerts/rules/{ruleId} Delete alert rule
AlertRulesApi get_alert_rule GET /alerts/rules/{ruleId} Retrieve alert rule
AlertRulesApi get_alerts_rules GET /alerts/rules List alert rules
AlertRulesApi update_alert_rule PUT /alerts/rules/{ruleId} Update alert rule
AlertSuppressionWindowsApi create_alert_suppression_window POST /alert-suppression-windows Create alert suppression window
AlertSuppressionWindowsApi delete_alert_suppression_window DELETE /alert-suppression-windows/{windowId} Delete alert suppression window
AlertSuppressionWindowsApi get_alert_suppression_window GET /alert-suppression-windows/{windowId} Retrieve alert suppression window
AlertSuppressionWindowsApi get_alert_suppression_windows GET /alert-suppression-windows List alert suppression windows
AlertSuppressionWindowsApi update_alert_suppression_window PUT /alert-suppression-windows/{windowId} Update alert suppression window
AlertsApi get_alert GET /alerts/{alertId} Retrieve alert details
AlertsApi get_alerts GET /alerts List active alerts

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author

ThousandEyes API Team