thousandeyes-sdk-tags 2.4.0

ThousandEyes SDK Tags API

thousandeyes-sdk-tags

The ThousandEyes Tags API provides a tagging system with key/value pairs. It allows you to tag assets within the ThousandEyes platform (such as agents, tests, or alert rules) with meaningful metadata. For example: branch:sfo, branch:nyc, and team:netops.

This feature provides:

• Support for automation.
• Powerful and flexible reports/dashboards.
• Support for third-party integrations.

Things to note with the ThousandEyes Tags API:

• Tags are backwards-compatible with existing labels.
• Tags are separated by Tests (CEA), Agents (CEA), Endpoint Agents, Scheduled Endpoint Tests, and Reports. A single tag can only apply to one type of target object, so each tag must specify the target type of object via a type field.
• Tags are defined in a single table so that they can be represented using a single model - Tag.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.32
• 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-tags

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-tags)

Then import the package:

import thousandeyes_sdk.tags

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.tags

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.tags
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.tags.TagAssignmentApi(api_client)
    id = 'c6b78e57-81a2-4c5f-a11a-d96c3c664d55' # str | Tag ID
    tag_assignment = thousandeyes_sdk.tags.TagAssignment() # TagAssignment | 
    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:
        # Assign tag to multiple objects
        api_response = api_instance.assign_tag(id, tag_assignment, aid=aid)
        print("The response of TagAssignmentApi->assign_tag:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TagAssignmentApi->assign_tag: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class	Method	HTTP request	Description
TagAssignmentApi	assign_tag	POST /tags/{id}/assign	Assign tag to multiple objects
TagAssignmentApi	assign_tags	POST /tags/assign	Assign multiple tags to multiple objects
TagAssignmentApi	unassign_tag	POST /tags/{id}/unassign	Remove tag from multiple objects
TagAssignmentApi	unassign_tags	POST /tags/unassign	Remove multiple tags from multiple objects
TagsApi	create_tag	POST /tags	Create tag
TagsApi	create_tags	POST /tags/bulk	Create multiple tags
TagsApi	delete_tag	DELETE /tags/{id}	Delete tag
TagsApi	get_tag	GET /tags/{id}	Retrieve tag
TagsApi	get_tags	GET /tags	List tags
TagsApi	update_tag	PUT /tags/{id}	Update tag

Documentation For Models

• AccessType
• ApiError
• Assignment
• AssignmentType
• BulkTagAssignment
• BulkTagAssignments
• BulkTagResponse
• Error
• ExpandTagsOptions
• Link
• ObjectType
• SelfLinks
• Tag
• TagAssignment
• TagBulkCreateError
• TagInfo
• Tags
• UnauthorizedError
• ValidationError
• ValidationErrorItem

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team