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.110
- 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
- Alert
- AlertDetail
- AlertDirection
- AlertEmbedded
- AlertGroupType
- AlertLinks
- AlertMeta
- AlertMetricDetail
- AlertNotification
- AlertRoundsViolationMode
- AlertSimpleTest
- AlertSuppressionWindow
- AlertSuppressionWindowDetail
- AlertSuppressionWindowRequest
- AlertSuppressionWindowState
- AlertSuppressionWindows
- AlertTestType
- AlertType
- Alerts
- Asn
- BaseAlert
- BaseAlertSuppressionWindow
- BaseRule
- CustomWebhookIntegrationType
- DaysOfWeek
- EndAlertMetrics
- EndRepeat
- EndRepeatType
- Error
- ExpandAlertTestOptions
- IntervalType
- LegacyAlert
- LegacyAlertDetail
- Link
- NotificationCustomWebhook
- NotificationEmail
- NotificationThirdParty
- NotificationWebhook
- PaginationLinks
- Repeat
- RepeatType
- Rule
- RuleDetail
- RuleDetailUpdate
- Rules
- SelfLinks
- SensitivityLevel
- Severity
- SimpleTest
- StartAlertMetrics
- State
- TestInterval
- TestLinks
- TestSelfLink
- TestType
- ThirdPartyIntegrationType
- UnauthorizedError
- ValidationError
- ValidationErrorItem
- WebhookIntegrationType
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
1 maintainer
Metadata
1 maintainer
Release files for thousandeyes-sdk-alerts 6.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| thousandeyes_sdk_alerts-6.0.0.tar.gz | 76.4 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| thousandeyes_sdk_alerts-6.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 215.3 kB
Release files / thousandeyes_sdk_alerts-6.0.0.tar.gz
| Download URL | thousandeyes_sdk_alerts-6.0.0.tar.gz |
|---|---|
| Size | 76.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
887f6a81cb07109935d99e44733d814a68be9191acc506783315dfa4b82151db
|
|
BLAKE2b-256 checksum How to use checksums |
7ef22c2755cd6bbf16ef2cd11b2b454c032d970e5231ce7e8fb84e9a40a98672
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / thousandeyes_sdk_alerts-6.0.0-py3-none-any.whl
| Download URL | thousandeyes_sdk_alerts-6.0.0-py3-none-any.whl |
|---|---|
| Size | 138.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4872330af2f3d4d33bf56bb39067666fb6ef54665aa54e5966a17122367c7c16
|
|
BLAKE2b-256 checksum How to use checksums |
93ce2fecec0955abb33d6d7e6a9d7ca933183c9648b6b294b5b3c2d6591f35a0
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logSecurity for thousandeyes-sdk-alerts 6.0.0
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for thousandeyes_sdk_alerts-6.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
