thousandeyes-sdk-labels
Overview
This is API for the Labels API (formerly called groups).
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 7.0.9
- 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-labels
(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-labels)
Then import the package:
import thousandeyes_sdk.labels
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.labels
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.labels
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
host = "https://api.thousandeyes.com"
)
# 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.labels.AgentApi(api_client)
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)
label_request = thousandeyes_sdk.labels.LabelRequest() # LabelRequest | Label resource (optional)
try:
# Create a Label of type `agent`
api_response = api_instance.create_agent_label(aid=aid, label_request=label_request)
print("The response of AgentApi->create_agent_label:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentApi->create_agent_label: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AgentApi | create_agent_label | POST /v7/labels/agent | Create a Label of type `agent` |
| AgentApi | delete_agent_label | DELETE /v7/labels/agent/{labelId} | Delete a Label object of type `agent` |
| AgentApi | get_agent_label | GET /v7/labels/agent/{labelId} | Get a Label object of type `agent` |
| AgentApi | get_agent_labels | GET /v7/labels/agent | Get list of Labels of type `agent` |
| AgentApi | update_agent_label | PUT /v7/labels/agent/{labelId} | Update a Label object of type `agent` |
| AllLabelsApi | get_labels | GET /v7/labels | Get list of Labels |
| DashboardApi | create_dashboard_label | POST /v7/labels/dashboard | Create a Label of type `dashboard` |
| DashboardApi | delete_dashboard_label | DELETE /v7/labels/dashboard/{labelId} | Delete a Label object of type `dashboard` |
| DashboardApi | get_dashboard_label | GET /v7/labels/dashboard/{labelId} | Get a Label object of type `dashboard` |
| DashboardApi | get_dashboard_labels | GET /v7/labels/dashboard | Get list of Labels of type `dashboard` |
| DashboardApi | update_dashboard_label | PUT /v7/labels/dashboard/{labelId} | Update a Label object of type `dashboard` |
| EndpointTestApi | create_endpoint_test_label | POST /v7/labels/endpoint-test | Create a Label of type `endpoint-test` |
| EndpointTestApi | delete_endpoint_test_label | DELETE /v7/labels/endpoint-test/{labelId} | Delete a Label object of type `endpoint-test` |
| EndpointTestApi | get_endpoint_test_label | GET /v7/labels/endpoint-test/{labelId} | Get a Label object of type `endpoint-test` |
| EndpointTestApi | get_endpoint_test_labels | GET /v7/labels/endpoint-test | Get list of Labels of type `endpoint-test` |
| EndpointTestApi | update_endpoint_test_label | PUT /v7/labels/endpoint-test/{labelId} | Update a Label object of type `endpoint-test` |
| TestApi | create_test_label | POST /v7/labels/test | Create a Label of type `test` |
| TestApi | delete_test_label | DELETE /v7/labels/test/{labelId} | Delete a Label object of type `test` |
| TestApi | get_test_label | GET /v7/labels/test/{labelId} | Get a Label object of type `test` |
| TestApi | get_test_labels | GET /v7/labels/test | Get list of Labels of type `test` |
| TestApi | update_test_label | PUT /v7/labels/test/{labelId} | Update a Label object of type `test` |
Documentation For Models
- Error
- Label
- LabelDetail
- LabelRequest
- LabelType
- Labels
- Link
- SelfLinks
- UnauthorizedError
- ValidationError
- ValidationErrorItem
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Metadata
Release files for thousandeyes-sdk-labels 1.1.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 | Actions |
|---|---|---|---|---|
| thousandeyes_sdk_labels-1.1.0.tar.gz | 35.9 kB | Without provenance | Details for thousandeyes_sdk_labels-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| thousandeyes_sdk_labels-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for thousandeyes_sdk_labels-1.1.0-py3-none-any.whl |
Total release size: 81.5 kB
Release files / thousandeyes_sdk_labels-1.1.0.tar.gz
| Download URL | thousandeyes_sdk_labels-1.1.0.tar.gz |
|---|---|
| Size | 35.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
463f088a80d0e9e446c89c97952f49c6da045301d25008461632c592e2c59a02
|
|
BLAKE2b-256 checksum How to use checksums |
9538077ca3c65358c5e3ea73596303d07c78fa66364f5e7ab30a55cbfbfba072
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / thousandeyes_sdk_labels-1.1.0-py3-none-any.whl
| Download URL | thousandeyes_sdk_labels-1.1.0-py3-none-any.whl |
|---|---|
| Size | 45.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
24cca975cca5aa83c8609e55660a2a1fbb6cf1f0f19b3800147e14d227bd16fe
|
|
BLAKE2b-256 checksum How to use checksums |
7b3247dd478ba3ed98b10ae3f77fddeca19a5793594294d445ec1104fed1d95d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Security for thousandeyes-sdk-labels 1.1.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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.