# thousandeyes-sdk-endpoint-labels
Manage labels applied to endpoint agents using this API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 7.0.4
- Package version: 1.0.0
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import thousandeyes_sdk.endpoint_labels
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import thousandeyes_sdk.endpoint_labels
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import thousandeyes_sdk.client
import thousandeyes_sdk.endpoint_labels
from thousandeyes_sdk.client.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.client.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.client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with thousandeyes_sdk.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = thousandeyes_sdk.endpoint_labels.ManageLabelsApi(api_client)
id = 'id_example' # str | The unique identifier of the label to operate on.
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:
# Delete label
api_instance.endpoint_label_delete(id, aid=aid)
except ApiException as e:
print("Exception when calling ManageLabelsApi->endpoint_label_delete: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.thousandeyes.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ManageLabelsApi* | [**endpoint_label_delete**](docs/ManageLabelsApi.md#endpoint_label_delete) | **DELETE** /v7/endpoint/labels/{id} | Delete label
*ManageLabelsApi* | [**endpoint_label_get**](docs/ManageLabelsApi.md#endpoint_label_get) | **GET** /v7/endpoint/labels/{id} | Retrieve label
*ManageLabelsApi* | [**endpoint_label_update**](docs/ManageLabelsApi.md#endpoint_label_update) | **PATCH** /v7/endpoint/labels/{id} | Update label
*ManageLabelsApi* | [**endpoint_labels_list**](docs/ManageLabelsApi.md#endpoint_labels_list) | **GET** /v7/endpoint/labels | List labels
*ManageLabelsApi* | [**v7_endpoint_labels_post**](docs/ManageLabelsApi.md#v7_endpoint_labels_post) | **POST** /v7/endpoint/labels | Create label
## Documentation For Models
- [Error](docs/Error.md)
- [Expand](docs/Expand.md)
- [Filter](docs/Filter.md)
- [FilterType](docs/FilterType.md)
- [Label](docs/Label.md)
- [LabelFilterMode](docs/LabelFilterMode.md)
- [LabelRequest](docs/LabelRequest.md)
- [LabelResponse](docs/LabelResponse.md)
- [Labels](docs/Labels.md)
- [Link](docs/Link.md)
- [MatchType](docs/MatchType.md)
- [PaginationNextAndSelfLink](docs/PaginationNextAndSelfLink.md)
- [SelfLinks](docs/SelfLinks.md)
- [UnauthorizedError](docs/UnauthorizedError.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorItem](docs/ValidationErrorItem.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### BearerAuth
- **Type**: Bearer authentication
## Author