thousandeyes-sdk-alerts

Note: API operations for the creation or retrieval of API, Page Load, or Web-Transaction alert rules are not available for ThousandEyes for Government instance.

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.104
Generator version: 7.6.0
Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.9+

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 alerts

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication

Author

ThousandEyes API Team

Metadata

Release files for thousandeyes-sdk-alerts 5.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for thousandeyes-sdk-alerts 5.0.0
File	Size	Uploaded
thousandeyes_sdk_alerts-5.0.0.tar.gz	76.7 kB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for thousandeyes-sdk-alerts 5.0.0
File	Interpreter	ABI	Platform	Reset
thousandeyes_sdk_alerts-5.0.0-py3-none-any.whl 138.8 kB Sep 9, 2026	Python 3	none	any	Details

Total release size: 215.5 kB

Release files / thousandeyes_sdk_alerts-5.0.0.tar.gz

Download URL	thousandeyes_sdk_alerts-5.0.0.tar.gz
Size	76.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`fbd536bce5735fedd997b922e2023f4f421a30ad392950e43ec9a9f83f355f9a`
BLAKE2b-256 checksum How to use checksums	`f353af2dd4844498cc36a2639b50540bb69aa24cec005757b453e5ffb410ad87`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/thousandeyes/thousandeyes-sdk-python
Publishing commit: github.com/thousandeyes/thousandeyes-sdk-python/tree/d4b7ca82b7f3047330d34be16b4542926adfb019

Workflow

Publishing configuration: github.com/thousandeyes/thousandeyes-sdk-python/blob/d4b7ca82b7f3047330d34be16b4542926adfb019/.github/workflows/release.yaml
Publishing logs: github.com/thousandeyes/thousandeyes-sdk-python/actions/runs/34372354794/attempts/1

Artifact

Subject: thousandeyes_sdk_alerts-5.0.0.tar.gz
SHA-256 checksum: fbd536bce5735fedd997b922e2023f4f421a30ad392950e43ec9a9f83f355f9a Verifying attestations

Release files / thousandeyes_sdk_alerts-5.0.0-py3-none-any.whl

Download URL	thousandeyes_sdk_alerts-5.0.0-py3-none-any.whl
Size	138.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d33844d8c5b3e8958eabe3c75615d8954f112157d99c9477b3a53b734500e2c3`
BLAKE2b-256 checksum How to use checksums	`8845e037bd2a2f46c8c0955c8d9f17deada3de478fbd7af7e02db0408101ae31`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/thousandeyes/thousandeyes-sdk-python
Publishing commit: github.com/thousandeyes/thousandeyes-sdk-python/tree/d4b7ca82b7f3047330d34be16b4542926adfb019

Workflow

Publishing configuration: github.com/thousandeyes/thousandeyes-sdk-python/blob/d4b7ca82b7f3047330d34be16b4542926adfb019/.github/workflows/release.yaml
Publishing logs: github.com/thousandeyes/thousandeyes-sdk-python/actions/runs/34372354794/attempts/1

Artifact

Subject: thousandeyes_sdk_alerts-5.0.0-py3-none-any.whl
SHA-256 checksum: d33844d8c5b3e8958eabe3c75615d8954f112157d99c9477b3a53b734500e2c3 Verifying attestations