ThousandEyes SDK Endpoint Agent Labels API
Project description
thousandeyes-sdk-endpoint-labels
Manage labels applied to endpoint agents using this API.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 7.0.8
- 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-endpoint-labels
(you may need to run pip
with root permission: sudo pip install thousandeyes-sdk-endpoint-labels
)
Then import the package:
import thousandeyes_sdk.endpoint_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.endpoint_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.endpoint_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.endpoint_labels.ManageLabelsApi(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.endpoint_labels.LabelRequest() # LabelRequest | Label settings (optional)
try:
# Create label
api_response = api_instance.create_endpoint_label(aid=aid, label_request=label_request)
print("The response of ManageLabelsApi->create_endpoint_label:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ManageLabelsApi->create_endpoint_label: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com
Class | Method | HTTP request | Description |
---|---|---|---|
ManageLabelsApi | create_endpoint_label | POST /v7/endpoint/labels | Create label |
ManageLabelsApi | delete_endpoint_label | DELETE /v7/endpoint/labels/{id} | Delete label |
ManageLabelsApi | get_endpoint_label | GET /v7/endpoint/labels/{id} | Retrieve label |
ManageLabelsApi | get_endpoint_labels | GET /v7/endpoint/labels | List labels |
ManageLabelsApi | update_endpoint_label | PATCH /v7/endpoint/labels/{id} | Update label |
Documentation For Models
- Error
- Expand
- Filter
- FilterType
- Label
- LabelFilterMode
- LabelRequest
- LabelResponse
- Labels
- Link
- MatchType
- PaginationNextAndSelfLink
- SelfLinks
- UnauthorizedError
- ValidationError
- ValidationErrorItem
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thousandeyes_sdk_endpoint_labels-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 304cd1275d08f09b375197861a1d5267c8a0173eb88cbb6e8b3638477a37ea9a |
|
MD5 | 05ebf410765ee31d4aeee4425e2cd873 |
|
BLAKE2b-256 | 61b85d67a36893cc8680990a2e88b1c32bac891db57dcd2a0a9d2496b2aa9ea4 |
Hashes for thousandeyes_sdk_endpoint_labels-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8144ef836ac475e7ecc2acf0886cc4b8caa45d8b0a25a97ef41a4c3afd3f48dc |
|
MD5 | 5e1126a272c4cc8b127707753a5e16a3 |
|
BLAKE2b-256 | 8d5e909995c07ec1548f55a2f6a659e9ce7d0553b84d8214f6e34124bdafb962 |