thousandeyes-sdk-usage 3.0.0

ThousandEyes SDK Usage API

thousandeyes-sdk-usage

These usage endpoints define the following operations:

• Usage: Retrieve usage data for the specified time period (default is one month).

  • Users must have the View organization usage permission to access this endpoint.
  • This operation offers visibility across all account groups within the organization.
  • Users with View organization usage permission in multiple organizations should query the operation with the aid query string parameter (see optional parameters) for each organization.
  • The agentId field in enterprise agent unit responses may be omitted when not available.

• Quotas: Obtain organization and account usage quotas. Additionally, users with the appropriate permissions can create, update, or delete these quotas.

  • Users must have the necessary permissions to perform quota-related actions.

Refer to the Usage API operations for detailed usage instructions and optional parameters.

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

• API version: 7.0.84
• 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-usage

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

Then import the package:

import thousandeyes_sdk.usage

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

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.usage
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.usage.QuotasApi(api_client)
    organizations_quotas_assign = thousandeyes_sdk.usage.OrganizationsQuotasAssign() # OrganizationsQuotasAssign |  (optional)

    try:
        # Create or update accout group quotas
        api_response = api_instance.assign_organizations_account_groups_quotas(organizations_quotas_assign=organizations_quotas_assign)
        print("The response of QuotasApi->assign_organizations_account_groups_quotas:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling QuotasApi->assign_organizations_account_groups_quotas: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
QuotasApi	assign_organizations_account_groups_quotas	POST /quotas/account-groups/assign	Create or update accout group quotas
QuotasApi	assign_organizations_quotas	POST /quotas/assign	Create or update organizations quotas
QuotasApi	get_quotas	GET /quotas	Get organization and account group usage quota
QuotasApi	unassign_organizations_account_groups_quotas	POST /quotas/account-groups/unassign	Remove account group quotas from organizations
QuotasApi	unassign_organizations_quotas	POST /quotas/unassign	Remove organization quotas
UsageApi	get_enterprise_agents_units_usage	GET /usage/units/enterprise-agents	Get enterprise agent usage
UsageApi	get_tests_units_usage	GET /usage/units/tests	Get cloud and enterprise agents units usage
UsageApi	get_usage	GET /usage	Get usage information for the last month

Documentation For Models

• AccountGroupQuota
• AllocationUnitUsageBreakdown
• EndpointAgentsEmbedded
• EndpointAgentsEssentials
• EndpointAgentsUsage
• EnterpriseAgentUnits
• EnterpriseAgentUnitsByTestOwnerAccountGroup
• EnterpriseAgents
• EnterpriseAgentsUsage
• Error
• ExpandUsageOptions
• Link
• OrganizationQuota
• OrganizationQuotaAssignment
• OrganizationQuotaUnassignment
• OrganizationsQuotasAssign
• OrganizationsQuotasUnassign
• PaginationLinks
• Quota
• Quotas
• QuotasAssignRequest
• QuotasAssignResponse
• QuotasUnassign
• SelfLinks
• TestUsage
• TestsUsage
• UnauthorizedError
• UnitAllocationSummary
• UnitsByTests
• Usage
• UsageDetails
• UsageQuota
• ValidationError
• ValidationErrorItem

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team