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.25
- 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/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.endpoint_labels.EndpointAgentLabelsApi(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 EndpointAgentLabelsApi->create_endpoint_label:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling EndpointAgentLabelsApi->create_endpoint_label: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com/v7
Class | Method | HTTP request | Description |
---|---|---|---|
EndpointAgentLabelsApi | create_endpoint_label | POST /endpoint/labels | Create label |
EndpointAgentLabelsApi | delete_endpoint_label | DELETE /endpoint/labels/{id} | Delete label |
EndpointAgentLabelsApi | get_endpoint_label | GET /endpoint/labels/{id} | Retrieve label |
EndpointAgentLabelsApi | get_endpoint_labels | GET /endpoint/labels | List labels |
EndpointAgentLabelsApi | update_endpoint_label | PATCH /endpoint/labels/{id} | Update label |
Documentation For Models
- Error
- ExpandLabelOptions
- 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-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b10000cce6307887dfd7294204a24f35c91cc18089c6818daca397e8a1f6b87 |
|
MD5 | 0798a038b07462b276ee2e927837d474 |
|
BLAKE2b-256 | 4f3cabf44ca8367b9a49c99474361d6dfc452074e8cbb2a89b197b5fdbcb98a7 |
Hashes for thousandeyes_sdk_endpoint_labels-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec82c5b7b3e89e918a8550e4a621243e26760fc4a4b4cd7914caf1881f753144 |
|
MD5 | 02286b3abe639959538d2c60a5d38eeb |
|
BLAKE2b-256 | 0c123a958a231ef9c048bcd983f52c824903895efef37acb28632409b6202174 |