thousandeyes-sdk-python/usage_api

usage-api

Overview

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 Billing permission to access this endpoint.
  • This endpoint offers visibility across all account groups within the organization.
  • Users with View Billing permission in multiple organizations should query the endpoint with the aid query string parameter (see optional parameters) for each organization.

• 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 API definitions below for detailed usage instructions and optional parameters.

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

• API version: 7.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git)

Then import the package:

import usage_api

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 usage_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import usage_api
from usage_api.rest 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 = usage_api.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 = usage_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with usage_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = usage_api.QuotasApi(api_client)
    aid = '2067' # 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)
    organizations_quotas_assign = usage_api.OrganizationsQuotasAssign() # OrganizationsQuotasAssign |  (optional)

    try:
        # Create or update accout group quotas
        api_response = api_instance.assign_organizations_account_groups_quotas(aid=aid, 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

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

Documentation For Models

• AccountGroup
• AccountGroupId
• AccountGroupQuota
• EndpointAgentsEmbeddedInner
• EndpointAgentsEssentialsInner
• EndpointAgentsInner
• EnterpriseAgentUnitsInner
• EnterpriseAgentsInner
• Error
• Expand
• GetQuotas200Response
• GetUsage200Response
• Link
• OrganizationQuota
• OrganizationsQuotasAssign
• OrganizationsQuotasAssignOrganizationsInner
• OrganizationsQuotasUnassign
• OrganizationsQuotasUnassignOrganizationsInner
• Quotas
• QuotasAssignRequest
• QuotasAssignResponse
• QuotasQuotasInner
• QuotasUnassign
• SelfLinks
• SelfLinksLinks
• TestsInner
• UnauthorizedError
• Usage
• UsageUsage
• UsageUsageQuota

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author