vrt-lss-account 7.38.3336

VRt.Account [AC]

vrt_lss_account

Description

Veeroute Account Panel.

Usage metrics

Service usage metrics are computed for each client and for each process type. They can be retrieved from the personal cabinet or via the api method.

The metrics are described by the following object:

<SchemaDefinition schemaRef="#/components/schemas/process_statistics" />

Entity diagram

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

• API version: 7.38.3336
• Package version: 7.38.3336
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

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

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:

import vrt_lss_account

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 vrt_lss_account

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import vrt_lss_account
from vrt_lss_account.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.edge7.veeroute.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = vrt_lss_account.Configuration(
    host = "https://api.edge7.veeroute.cloud"
)

# 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 (JWT): ApiKeyAuth
configuration = vrt_lss_account.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_account.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_account.AuditApi(api_client)
    offset = 0 # int | The number of items to skip before starting to collect the result set. (optional) (default to 0)
    limit = 100 # int | The number of items to return. (optional) (default to 100)
    var_from = '2026-04-21T09:30:00+03:00' # datetime | Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. If no datetime is specified, audit data are returned from the beginning of the day.  (optional)
    to = '2026-04-21T18:00:00+03:00' # datetime | Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. If not specified, data up to the current time is returned.  (optional)
    service = vrt_lss_account.Service() # Service | Service name. (optional)
    operation = 'operation_example' # str | Operation name. (optional)
    process_type = vrt_lss_account.ProcessType() # ProcessType | Process type. (optional)
    status = vrt_lss_account.CalculationStatus() # CalculationStatus | Process status. (optional)
    sort_field = 'name' # str | Field to sort by. (optional)
    sort_direction = ASC # str | Sort direction. (optional) (default to ASC)

    try:
        # Actions for the period
        api_response = api_instance.read_audit(offset=offset, limit=limit, var_from=var_from, to=to, service=service, operation=operation, process_type=process_type, status=status, sort_field=sort_field, sort_direction=sort_direction)
        print("The response of AuditApi->read_audit:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuditApi->read_audit: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.edge7.veeroute.cloud

Class	Method	HTTP request	Description
AuditApi	read_audit	GET /account/audit	Actions for the period
AuthApi	change_password	POST /account/password	Change password
AuthApi	run_token_generation	POST /account/token/generation	Obtaining a token
AuthApi	run_token_validation	POST /account/token/validation	Validating a token
DataApi	read_data	GET /account/data/{process_code}	Reading input data
InfoApi	read_info	GET /account/info	Account information
InfoApi	update_info	PUT /account/info	Account update
QuotaApi	read_quota	GET /account/quota	Obtaining the quotas
StatisticsApi	generate_report	GET /account/report	Report creating
StatisticsApi	generate_statistics	GET /account/statistics	Statistics for the period
SystemApi	check	GET /account/system/check	Checking the availability
SystemApi	file	GET /account/file/{filename}	Getting the documentation
SystemApi	version	GET /account/system/version	Getting the service version

Documentation For Models

• AccountAuditResult
• Attribute
• AuditAction
• AuditActionStatistics
• AuditCounters
• AuditCountersDetail
• CalculationInfo
• CalculationStatus
• CheckResult
• DateStatistics
• FlowStage
• FlowType
• General400
• General402
• General403
• General404
• General404Detail
• General429
• General500
• InfoChangeRequest
• PasswordChangeRequest
• ProcessQuota
• ProcessStatistics
• ProcessType
• QuotaBase
• QuotasResult
• SchemaError
• Service
• ServiceQuota
• ServiceStatistics
• TokenRequest
• TokenValidationResult
• Tracedata
• User
• UserRole
• UserStatistics
• VersionResult

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: Bearer authentication (JWT)

Author

[e-mail]