ThousandEyes SDK Usage API
Project description
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 theaid
query string parameter (see optional parameters) for each organization.
- Users must have the
-
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.22
- 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
- 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
- UnitsByTests
- Usage
- UsageDetails
- UsageQuota
- 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_usage-2.0.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6505af43d984123c2a671ef6c378e3468af6bb8551ccd9378d5dfa6b4803881 |
|
MD5 | e8cd3fadb083e2c28ccd20fd900e24f2 |
|
BLAKE2b-256 | 49a6e2b46a596114bc892febc1e8462a84eee1f5f069ca91128afb57d2b7bcc6 |
Hashes for thousandeyes_sdk_usage-2.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 343b8a48e3629da65f6d532bbc0c257dc5a337f3c54ec1dc2d7c973e7aa95f79 |
|
MD5 | b84def62465d16a54964dc19b2e403b6 |
|
BLAKE2b-256 | 0f770b699493b7366a63a3ece3daa43b711fdf582e65abc384cb53c1fd62c88a |