torizon-io-api

This API is rate limited and will return the following headers for each API call.

• X-RateLimit-Limit - The total number of requests allowed within a time period
• X-RateLimit-Remaining - The total number of requests still allowed until the end of the rate limiting period
• X-RateLimit-Reset - The number of seconds until the limit is fully reset

In addition, if an API client is rate limited, it will receive a HTTP 420 response with the following header:

• Retry-After - The number of seconds to wait until this request is allowed

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

• API version: 2.0-Beta
• Package version: 0.0.7
• Generator version: 7.20.0-SNAPSHOT
• 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 torizon_io_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 torizon_io_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import torizon_io_api
from torizon_io_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.torizon.io/api/v2beta
# See configuration.py for a list of all supported configuration parameters.
configuration = torizon_io_api.Configuration(
    host = "https://app.torizon.io/api/v2beta"
)

# 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 = torizon_io_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with torizon_io_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = torizon_io_api.DeviceMetricsApi(api_client)
    device_uuid = 'device_uuid_example' # str | 
    metrics = ['metrics_example'] # List[str] | 
    var_from = 56 # int | 
    to = 56 # int | 
    raw_datapoints = 56 # int |  (optional)
    total_buckets = 56 # int |  (optional)

    try:
        # Get detailed metrics data for a single device
        api_response = api_instance.get_device_data_devices_deviceuuid_detailed_metrics(device_uuid, metrics, var_from, to, raw_datapoints=raw_datapoints, total_buckets=total_buckets)
        print("The response of DeviceMetricsApi->get_device_data_devices_deviceuuid_detailed_metrics:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DeviceMetricsApi->get_device_data_devices_deviceuuid_detailed_metrics: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://app.torizon.io/api/v2beta

Documentation For Models

• BadRequestRepr
• ClientSignature
• ConflictRepr
• CreateFleet
• CreateLockboxRequest
• CreateSessionRequest
• CustomUpdateData
• DelegationInfo
• DetailedMetricQuery
• DeviceCreateReq
• DeviceInfo
• DeviceInfoBasic
• DeviceInfoExtended
• DeviceNameRequest
• DeviceNotesRequest
• DevicePackage
• DevicePackages
• DeviceSession
• DeviceSort
• DeviceSortDirection
• DeviceStatus
• EcuInfoImage
• EcuInfoResponse
• EditPackage
• ErrorRepresentation
• ExternalPackage
• FileInfo
• Fleet
• FleetMetricsOutliersRequest
• FleetMetricsOutliersResponse
• FleetType
• Image
• InstalledPackage
• IpAddressRequest
• JsonSignedPayload
• KeyData
• LastSshSession
• MetricsResponse
• NetworkInfo
• NotFoundRepr
• Outlier
• OutlierAggregationMethod
• OutlierValues
• Package
• PackageInfo
• PaginationResultComToradexApiGwDataDeviceInfoBasic
• PaginationResultComToradexApiGwDataDevicePackages
• PaginationResultComToradexApiGwDataFleet
• PaginationResultComToradexApiGwDataNetworkInfo
• PaginationResultComToradexApiGwDataPackagesExternalPackage
• PaginationResultComToradexApiGwDataPackagesPackage
• PaginationResultJavaLangString
• ProvisionInfo
• PublicKeys
• QueueResponse
• RangeNotSatisfiableRepr
• Series
• SeriesMeta
• SignatureMethod
• SimpleDeviceInfo
• SimpleDeviceNotAffectedInfo
• SortDirection
• SshSession
• TargetImage
• TargetItemsSort
• TimeAggregation
• TimeAggregationMethod
• Tuple2ComToradexApiGwDataDeviceTagIdComToradexApiGwDataDeviceTagValue
• Tuple2ScalaLongScalaOptionScalaDouble
• UpdateCreateResult
• UpdateFleet
• UpdateHibernationStatusRequest
• UpdateRequest
• UpstreamEndpointErrorRepr
• UserInfo
• UserSession

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author