# 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](https://openapi-generator.tech) project:
- API version: 2.0-Beta
- Package version: 0.0.2
- Generator version: 7.11.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.8+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
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:
```python
import torizon_io_api
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import torizon_io_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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 |
var_from = 56 # int |
to = 56 # int |
metric = ['metric_example'] # List[str] | (optional)
resolution = 56 # int | (optional)
try:
# Get metrics data from a single device
api_response = api_instance.get_device_data_devices_deviceuuid_metrics(device_uuid, var_from, to, metric=metric, resolution=resolution)
print("The response of DeviceMetricsApi->get_device_data_devices_deviceuuid_metrics:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceMetricsApi->get_device_data_devices_deviceuuid_metrics: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://app.torizon.io/api/v2beta*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DeviceMetricsApi* | [**get_device_data_devices_deviceuuid_metrics**](docs/DeviceMetricsApi.md#get_device_data_devices_deviceuuid_metrics) | **GET** /device-data/devices/{deviceUuid}/metrics | Get metrics data from a single device
*DeviceMetricsApi* | [**get_device_data_fleets_fleetid_metrics**](docs/DeviceMetricsApi.md#get_device_data_fleets_fleetid_metrics) | **GET** /device-data/fleets/{fleetId}/metrics | Get aggregated metrics data from a fleet of devices
*DeviceMetricsApi* | [**get_device_data_metric_names**](docs/DeviceMetricsApi.md#get_device_data_metric_names) | **GET** /device-data/metric-names | Get the list of metrics available in your repository
*DevicesApi* | [**delete_devices_deviceuuid**](docs/DevicesApi.md#delete_devices_deviceuuid) | **DELETE** /devices/{deviceUuid} | Delete a single device
*DevicesApi* | [**get_devices**](docs/DevicesApi.md#get_devices) | **GET** /devices | Query device information
*DevicesApi* | [**get_devices_deviceuuid**](docs/DevicesApi.md#get_devices_deviceuuid) | **GET** /devices/{deviceUuid} | Get detailed information about a single device
*DevicesApi* | [**get_devices_name_deviceuuid**](docs/DevicesApi.md#get_devices_name_deviceuuid) | **GET** /devices/name/{deviceUuid} | Get the display name of a single device
*DevicesApi* | [**get_devices_network**](docs/DevicesApi.md#get_devices_network) | **GET** /devices/network | Get network information for many devices
*DevicesApi* | [**get_devices_network_deviceuuid**](docs/DevicesApi.md#get_devices_network_deviceuuid) | **GET** /devices/network/{deviceUuid} | Get network information for a single device
*DevicesApi* | [**get_devices_notes_deviceuuid**](docs/DevicesApi.md#get_devices_notes_deviceuuid) | **GET** /devices/notes/{deviceUuid} | Get the device notes for a specific device
*DevicesApi* | [**get_devices_packages**](docs/DevicesApi.md#get_devices_packages) | **GET** /devices/packages | Get information about the installed packages for many devices
*DevicesApi* | [**get_devices_packages_deviceuuid**](docs/DevicesApi.md#get_devices_packages_deviceuuid) | **GET** /devices/packages/{deviceUuid} | Get information about the installed packages for a single device
*DevicesApi* | [**get_devices_token**](docs/DevicesApi.md#get_devices_token) | **GET** /devices/token | Retrieve device provisioning token
*DevicesApi* | [**get_devices_uptane_deviceuuid_assignment**](docs/DevicesApi.md#get_devices_uptane_deviceuuid_assignment) | **GET** /devices/uptane/{deviceUuid}/assignment | Show detailed information about the currently-assigned update for a single device
*DevicesApi* | [**get_devices_uptane_deviceuuid_components**](docs/DevicesApi.md#get_devices_uptane_deviceuuid_components) | **GET** /devices/uptane/{deviceUuid}/components | Get a list of the software components reported by a single device
*DevicesApi* | [**post_devices**](docs/DevicesApi.md#post_devices) | **POST** /devices | Manually create a new device
*DevicesApi* | [**put_devices_hibernation_deviceuuid**](docs/DevicesApi.md#put_devices_hibernation_deviceuuid) | **PUT** /devices/hibernation/{deviceUuid} | Set the hibernation status of a device
*DevicesApi* | [**put_devices_name_deviceuuid**](docs/DevicesApi.md#put_devices_name_deviceuuid) | **PUT** /devices/name/{deviceUuid} | Set the display name of a single device
*DevicesApi* | [**put_devices_notes_deviceuuid**](docs/DevicesApi.md#put_devices_notes_deviceuuid) | **PUT** /devices/notes/{deviceUuid} | Set the device notes for a specific device
*FleetsApi* | [**delete_fleets_fleetid**](docs/FleetsApi.md#delete_fleets_fleetid) | **DELETE** /fleets/{fleetId} | Delete a fleet
*FleetsApi* | [**delete_fleets_fleetid_devices**](docs/FleetsApi.md#delete_fleets_fleetid_devices) | **DELETE** /fleets/{fleetId}/devices | Remove devices from a fleet
*FleetsApi* | [**get_fleets**](docs/FleetsApi.md#get_fleets) | **GET** /fleets | Get information about all fleets in your repository
*FleetsApi* | [**get_fleets_fleetid**](docs/FleetsApi.md#get_fleets_fleetid) | **GET** /fleets/{fleetId} | Get information about a single fleet in your repository
*FleetsApi* | [**get_fleets_fleetid_devices**](docs/FleetsApi.md#get_fleets_fleetid_devices) | **GET** /fleets/{fleetId}/devices | Get information about the devices in a single fleet
*FleetsApi* | [**post_fleets**](docs/FleetsApi.md#post_fleets) | **POST** /fleets | Create a new fleet
*FleetsApi* | [**post_fleets_fleetid_devices**](docs/FleetsApi.md#post_fleets_fleetid_devices) | **POST** /fleets/{fleetId}/devices | Add devices to a fleet
*FleetsApi* | [**put_fleets_fleetid**](docs/FleetsApi.md#put_fleets_fleetid) | **PUT** /fleets/{fleetId} | Update fleet
*PackagesApi* | [**delete_packages_packageid**](docs/PackagesApi.md#delete_packages_packageid) | **DELETE** /packages/{packageId} | Delete a package
*PackagesApi* | [**get_packages**](docs/PackagesApi.md#get_packages) | **GET** /packages | Retrieve metadata about packages in your repository
*PackagesApi* | [**get_packages_external**](docs/PackagesApi.md#get_packages_external) | **GET** /packages_external | Retrieve metadata about packages in your repository from other sources
*PackagesApi* | [**get_packages_external_info**](docs/PackagesApi.md#get_packages_external_info) | **GET** /packages_external/info | Fetch information about external package sources
*PackagesApi* | [**get_packages_external_refresh_source_file_name**](docs/PackagesApi.md#get_packages_external_refresh_source_file_name) | **GET** /packages_external/refresh/{source_file_name} | Refresh metadata from an external package source
*PackagesApi* | [**patch_packages_packageid**](docs/PackagesApi.md#patch_packages_packageid) | **PATCH** /packages/{packageId} | Edit metadata about a package
*PackagesApi* | [**post_packages**](docs/PackagesApi.md#post_packages) | **POST** /packages | Upload a new package
*UpdatesApi* | [**delete_lockboxes_lockbox_name**](docs/UpdatesApi.md#delete_lockboxes_lockbox_name) | **DELETE** /lockboxes/{lockbox_name} | Delete a lockbox
*UpdatesApi* | [**get_lockbox_details**](docs/UpdatesApi.md#get_lockbox_details) | **GET** /lockbox-details | List all existing lockboxes on the repository, and their detailed contents
*UpdatesApi* | [**get_lockboxes**](docs/UpdatesApi.md#get_lockboxes) | **GET** /lockboxes | List all existing lockboxes on the repository
*UpdatesApi* | [**get_lockboxes_lockbox_name**](docs/UpdatesApi.md#get_lockboxes_lockbox_name) | **GET** /lockboxes/{lockbox_name} | Get the raw Uptane metadata for a lockbox
*UpdatesApi* | [**patch_updates**](docs/UpdatesApi.md#patch_updates) | **PATCH** /updates | Cancel a pending update for one or more devices
*UpdatesApi* | [**post_lockboxes_lockbox_name**](docs/UpdatesApi.md#post_lockboxes_lockbox_name) | **POST** /lockboxes/{lockbox_name} | Define a new lockbox, or update an existing one
*UpdatesApi* | [**post_updates**](docs/UpdatesApi.md#post_updates) | **POST** /updates | Launch an update to one or more devices or fleets
## Documentation For Models
- [BadRequestRepr](docs/BadRequestRepr.md)
- [ClientSignature](docs/ClientSignature.md)
- [ConflictRepr](docs/ConflictRepr.md)
- [CreateFleet](docs/CreateFleet.md)
- [CreateLockboxRequest](docs/CreateLockboxRequest.md)
- [CustomUpdateData](docs/CustomUpdateData.md)
- [DelegationInfo](docs/DelegationInfo.md)
- [DeviceCreateReq](docs/DeviceCreateReq.md)
- [DeviceInfoBasic](docs/DeviceInfoBasic.md)
- [DeviceInfoExtended](docs/DeviceInfoExtended.md)
- [DevicePackage](docs/DevicePackage.md)
- [DevicePackages](docs/DevicePackages.md)
- [DeviceSort](docs/DeviceSort.md)
- [DeviceSortDirection](docs/DeviceSortDirection.md)
- [DeviceStatus](docs/DeviceStatus.md)
- [EcuInfoImage](docs/EcuInfoImage.md)
- [EcuInfoResponse](docs/EcuInfoResponse.md)
- [EditPackage](docs/EditPackage.md)
- [ErrorRepresentation](docs/ErrorRepresentation.md)
- [ExternalPackage](docs/ExternalPackage.md)
- [FileInfo](docs/FileInfo.md)
- [Fleet](docs/Fleet.md)
- [FleetType](docs/FleetType.md)
- [Image](docs/Image.md)
- [InstalledPackage](docs/InstalledPackage.md)
- [JsonSignedPayload](docs/JsonSignedPayload.md)
- [MetricsResponse](docs/MetricsResponse.md)
- [NetworkInfo](docs/NetworkInfo.md)
- [NotFoundRepr](docs/NotFoundRepr.md)
- [Package](docs/Package.md)
- [PackageInfo](docs/PackageInfo.md)
- [PaginationResultDeviceInfoBasic](docs/PaginationResultDeviceInfoBasic.md)
- [PaginationResultDevicePackages](docs/PaginationResultDevicePackages.md)
- [PaginationResultExternalPackage](docs/PaginationResultExternalPackage.md)
- [PaginationResultFleet](docs/PaginationResultFleet.md)
- [PaginationResultNetworkInfo](docs/PaginationResultNetworkInfo.md)
- [PaginationResultPackage](docs/PaginationResultPackage.md)
- [PaginationResultString](docs/PaginationResultString.md)
- [ProvisionInfo](docs/ProvisionInfo.md)
- [QueueResponse](docs/QueueResponse.md)
- [RangeNotSatisfiableRepr](docs/RangeNotSatisfiableRepr.md)
- [Series](docs/Series.md)
- [SeriesMeta](docs/SeriesMeta.md)
- [SignatureMethod](docs/SignatureMethod.md)
- [SimpleDeviceInfo](docs/SimpleDeviceInfo.md)
- [SimpleDeviceNotAffectedInfo](docs/SimpleDeviceNotAffectedInfo.md)
- [SortDirection](docs/SortDirection.md)
- [TargetImage](docs/TargetImage.md)
- [TargetItemsSort](docs/TargetItemsSort.md)
- [TimeAggregation](docs/TimeAggregation.md)
- [TimeAggregationMethod](docs/TimeAggregationMethod.md)
- [Tuple2DeviceTagIdDeviceTagValue](docs/Tuple2DeviceTagIdDeviceTagValue.md)
- [Tuple2LongOptionDouble](docs/Tuple2LongOptionDouble.md)
- [UpdateCreateResult](docs/UpdateCreateResult.md)
- [UpdateFleet](docs/UpdateFleet.md)
- [UpdateHibernationStatusRequest](docs/UpdateHibernationStatusRequest.md)
- [UpdateRequest](docs/UpdateRequest.md)
- [UpstreamEndpointErrorRepr](docs/UpstreamEndpointErrorRepr.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth
- **Type**: Bearer authentication
<a id="Oauth2"></a>
### Oauth2
- **Type**: OAuth
- **Flow**: application
- **Authorization URL**:
- **Scopes**:
- **profile**: Default scope; automatically added and not currently used.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "torizon-io-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Torizon OTA",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/42/16/85abaa4d85df674c1fcba8880595f55ab13d433a23f39e01e9e8c25759d2/torizon_io_api-0.0.2.tar.gz",
"platform": null,
"description": "# torizon-io-api\n\nThis API is rate limited and will return the following headers for each API call.\n\n - X-RateLimit-Limit - The total number of requests allowed within a time period\n - X-RateLimit-Remaining - The total number of requests still allowed until the end of the rate limiting period\n - X-RateLimit-Reset - The number of seconds until the limit is fully reset\n\nIn addition, if an API client is rate limited, it will receive a HTTP 420 response with the following header:\n\n - Retry-After - The number of seconds to wait until this request is allowed\n\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2.0-Beta\n- Package version: 0.0.2\n- Generator version: 7.11.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport torizon_io_api\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport torizon_io_api\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport torizon_io_api\nfrom torizon_io_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://app.torizon.io/api/v2beta\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = torizon_io_api.Configuration(\n host = \"https://app.torizon.io/api/v2beta\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: BearerAuth\nconfiguration = torizon_io_api.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith torizon_io_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = torizon_io_api.DeviceMetricsApi(api_client)\n device_uuid = 'device_uuid_example' # str | \n var_from = 56 # int | \n to = 56 # int | \n metric = ['metric_example'] # List[str] | (optional)\n resolution = 56 # int | (optional)\n\n try:\n # Get metrics data from a single device\n api_response = api_instance.get_device_data_devices_deviceuuid_metrics(device_uuid, var_from, to, metric=metric, resolution=resolution)\n print(\"The response of DeviceMetricsApi->get_device_data_devices_deviceuuid_metrics:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DeviceMetricsApi->get_device_data_devices_deviceuuid_metrics: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://app.torizon.io/api/v2beta*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DeviceMetricsApi* | [**get_device_data_devices_deviceuuid_metrics**](docs/DeviceMetricsApi.md#get_device_data_devices_deviceuuid_metrics) | **GET** /device-data/devices/{deviceUuid}/metrics | Get metrics data from a single device\n*DeviceMetricsApi* | [**get_device_data_fleets_fleetid_metrics**](docs/DeviceMetricsApi.md#get_device_data_fleets_fleetid_metrics) | **GET** /device-data/fleets/{fleetId}/metrics | Get aggregated metrics data from a fleet of devices\n*DeviceMetricsApi* | [**get_device_data_metric_names**](docs/DeviceMetricsApi.md#get_device_data_metric_names) | **GET** /device-data/metric-names | Get the list of metrics available in your repository\n*DevicesApi* | [**delete_devices_deviceuuid**](docs/DevicesApi.md#delete_devices_deviceuuid) | **DELETE** /devices/{deviceUuid} | Delete a single device\n*DevicesApi* | [**get_devices**](docs/DevicesApi.md#get_devices) | **GET** /devices | Query device information\n*DevicesApi* | [**get_devices_deviceuuid**](docs/DevicesApi.md#get_devices_deviceuuid) | **GET** /devices/{deviceUuid} | Get detailed information about a single device\n*DevicesApi* | [**get_devices_name_deviceuuid**](docs/DevicesApi.md#get_devices_name_deviceuuid) | **GET** /devices/name/{deviceUuid} | Get the display name of a single device\n*DevicesApi* | [**get_devices_network**](docs/DevicesApi.md#get_devices_network) | **GET** /devices/network | Get network information for many devices\n*DevicesApi* | [**get_devices_network_deviceuuid**](docs/DevicesApi.md#get_devices_network_deviceuuid) | **GET** /devices/network/{deviceUuid} | Get network information for a single device\n*DevicesApi* | [**get_devices_notes_deviceuuid**](docs/DevicesApi.md#get_devices_notes_deviceuuid) | **GET** /devices/notes/{deviceUuid} | Get the device notes for a specific device\n*DevicesApi* | [**get_devices_packages**](docs/DevicesApi.md#get_devices_packages) | **GET** /devices/packages | Get information about the installed packages for many devices\n*DevicesApi* | [**get_devices_packages_deviceuuid**](docs/DevicesApi.md#get_devices_packages_deviceuuid) | **GET** /devices/packages/{deviceUuid} | Get information about the installed packages for a single device\n*DevicesApi* | [**get_devices_token**](docs/DevicesApi.md#get_devices_token) | **GET** /devices/token | Retrieve device provisioning token\n*DevicesApi* | [**get_devices_uptane_deviceuuid_assignment**](docs/DevicesApi.md#get_devices_uptane_deviceuuid_assignment) | **GET** /devices/uptane/{deviceUuid}/assignment | Show detailed information about the currently-assigned update for a single device\n*DevicesApi* | [**get_devices_uptane_deviceuuid_components**](docs/DevicesApi.md#get_devices_uptane_deviceuuid_components) | **GET** /devices/uptane/{deviceUuid}/components | Get a list of the software components reported by a single device\n*DevicesApi* | [**post_devices**](docs/DevicesApi.md#post_devices) | **POST** /devices | Manually create a new device\n*DevicesApi* | [**put_devices_hibernation_deviceuuid**](docs/DevicesApi.md#put_devices_hibernation_deviceuuid) | **PUT** /devices/hibernation/{deviceUuid} | Set the hibernation status of a device\n*DevicesApi* | [**put_devices_name_deviceuuid**](docs/DevicesApi.md#put_devices_name_deviceuuid) | **PUT** /devices/name/{deviceUuid} | Set the display name of a single device\n*DevicesApi* | [**put_devices_notes_deviceuuid**](docs/DevicesApi.md#put_devices_notes_deviceuuid) | **PUT** /devices/notes/{deviceUuid} | Set the device notes for a specific device\n*FleetsApi* | [**delete_fleets_fleetid**](docs/FleetsApi.md#delete_fleets_fleetid) | **DELETE** /fleets/{fleetId} | Delete a fleet\n*FleetsApi* | [**delete_fleets_fleetid_devices**](docs/FleetsApi.md#delete_fleets_fleetid_devices) | **DELETE** /fleets/{fleetId}/devices | Remove devices from a fleet\n*FleetsApi* | [**get_fleets**](docs/FleetsApi.md#get_fleets) | **GET** /fleets | Get information about all fleets in your repository\n*FleetsApi* | [**get_fleets_fleetid**](docs/FleetsApi.md#get_fleets_fleetid) | **GET** /fleets/{fleetId} | Get information about a single fleet in your repository\n*FleetsApi* | [**get_fleets_fleetid_devices**](docs/FleetsApi.md#get_fleets_fleetid_devices) | **GET** /fleets/{fleetId}/devices | Get information about the devices in a single fleet\n*FleetsApi* | [**post_fleets**](docs/FleetsApi.md#post_fleets) | **POST** /fleets | Create a new fleet\n*FleetsApi* | [**post_fleets_fleetid_devices**](docs/FleetsApi.md#post_fleets_fleetid_devices) | **POST** /fleets/{fleetId}/devices | Add devices to a fleet\n*FleetsApi* | [**put_fleets_fleetid**](docs/FleetsApi.md#put_fleets_fleetid) | **PUT** /fleets/{fleetId} | Update fleet\n*PackagesApi* | [**delete_packages_packageid**](docs/PackagesApi.md#delete_packages_packageid) | **DELETE** /packages/{packageId} | Delete a package\n*PackagesApi* | [**get_packages**](docs/PackagesApi.md#get_packages) | **GET** /packages | Retrieve metadata about packages in your repository\n*PackagesApi* | [**get_packages_external**](docs/PackagesApi.md#get_packages_external) | **GET** /packages_external | Retrieve metadata about packages in your repository from other sources\n*PackagesApi* | [**get_packages_external_info**](docs/PackagesApi.md#get_packages_external_info) | **GET** /packages_external/info | Fetch information about external package sources\n*PackagesApi* | [**get_packages_external_refresh_source_file_name**](docs/PackagesApi.md#get_packages_external_refresh_source_file_name) | **GET** /packages_external/refresh/{source_file_name} | Refresh metadata from an external package source\n*PackagesApi* | [**patch_packages_packageid**](docs/PackagesApi.md#patch_packages_packageid) | **PATCH** /packages/{packageId} | Edit metadata about a package\n*PackagesApi* | [**post_packages**](docs/PackagesApi.md#post_packages) | **POST** /packages | Upload a new package\n*UpdatesApi* | [**delete_lockboxes_lockbox_name**](docs/UpdatesApi.md#delete_lockboxes_lockbox_name) | **DELETE** /lockboxes/{lockbox_name} | Delete a lockbox\n*UpdatesApi* | [**get_lockbox_details**](docs/UpdatesApi.md#get_lockbox_details) | **GET** /lockbox-details | List all existing lockboxes on the repository, and their detailed contents\n*UpdatesApi* | [**get_lockboxes**](docs/UpdatesApi.md#get_lockboxes) | **GET** /lockboxes | List all existing lockboxes on the repository\n*UpdatesApi* | [**get_lockboxes_lockbox_name**](docs/UpdatesApi.md#get_lockboxes_lockbox_name) | **GET** /lockboxes/{lockbox_name} | Get the raw Uptane metadata for a lockbox\n*UpdatesApi* | [**patch_updates**](docs/UpdatesApi.md#patch_updates) | **PATCH** /updates | Cancel a pending update for one or more devices\n*UpdatesApi* | [**post_lockboxes_lockbox_name**](docs/UpdatesApi.md#post_lockboxes_lockbox_name) | **POST** /lockboxes/{lockbox_name} | Define a new lockbox, or update an existing one\n*UpdatesApi* | [**post_updates**](docs/UpdatesApi.md#post_updates) | **POST** /updates | Launch an update to one or more devices or fleets\n\n\n## Documentation For Models\n\n - [BadRequestRepr](docs/BadRequestRepr.md)\n - [ClientSignature](docs/ClientSignature.md)\n - [ConflictRepr](docs/ConflictRepr.md)\n - [CreateFleet](docs/CreateFleet.md)\n - [CreateLockboxRequest](docs/CreateLockboxRequest.md)\n - [CustomUpdateData](docs/CustomUpdateData.md)\n - [DelegationInfo](docs/DelegationInfo.md)\n - [DeviceCreateReq](docs/DeviceCreateReq.md)\n - [DeviceInfoBasic](docs/DeviceInfoBasic.md)\n - [DeviceInfoExtended](docs/DeviceInfoExtended.md)\n - [DevicePackage](docs/DevicePackage.md)\n - [DevicePackages](docs/DevicePackages.md)\n - [DeviceSort](docs/DeviceSort.md)\n - [DeviceSortDirection](docs/DeviceSortDirection.md)\n - [DeviceStatus](docs/DeviceStatus.md)\n - [EcuInfoImage](docs/EcuInfoImage.md)\n - [EcuInfoResponse](docs/EcuInfoResponse.md)\n - [EditPackage](docs/EditPackage.md)\n - [ErrorRepresentation](docs/ErrorRepresentation.md)\n - [ExternalPackage](docs/ExternalPackage.md)\n - [FileInfo](docs/FileInfo.md)\n - [Fleet](docs/Fleet.md)\n - [FleetType](docs/FleetType.md)\n - [Image](docs/Image.md)\n - [InstalledPackage](docs/InstalledPackage.md)\n - [JsonSignedPayload](docs/JsonSignedPayload.md)\n - [MetricsResponse](docs/MetricsResponse.md)\n - [NetworkInfo](docs/NetworkInfo.md)\n - [NotFoundRepr](docs/NotFoundRepr.md)\n - [Package](docs/Package.md)\n - [PackageInfo](docs/PackageInfo.md)\n - [PaginationResultDeviceInfoBasic](docs/PaginationResultDeviceInfoBasic.md)\n - [PaginationResultDevicePackages](docs/PaginationResultDevicePackages.md)\n - [PaginationResultExternalPackage](docs/PaginationResultExternalPackage.md)\n - [PaginationResultFleet](docs/PaginationResultFleet.md)\n - [PaginationResultNetworkInfo](docs/PaginationResultNetworkInfo.md)\n - [PaginationResultPackage](docs/PaginationResultPackage.md)\n - [PaginationResultString](docs/PaginationResultString.md)\n - [ProvisionInfo](docs/ProvisionInfo.md)\n - [QueueResponse](docs/QueueResponse.md)\n - [RangeNotSatisfiableRepr](docs/RangeNotSatisfiableRepr.md)\n - [Series](docs/Series.md)\n - [SeriesMeta](docs/SeriesMeta.md)\n - [SignatureMethod](docs/SignatureMethod.md)\n - [SimpleDeviceInfo](docs/SimpleDeviceInfo.md)\n - [SimpleDeviceNotAffectedInfo](docs/SimpleDeviceNotAffectedInfo.md)\n - [SortDirection](docs/SortDirection.md)\n - [TargetImage](docs/TargetImage.md)\n - [TargetItemsSort](docs/TargetItemsSort.md)\n - [TimeAggregation](docs/TimeAggregation.md)\n - [TimeAggregationMethod](docs/TimeAggregationMethod.md)\n - [Tuple2DeviceTagIdDeviceTagValue](docs/Tuple2DeviceTagIdDeviceTagValue.md)\n - [Tuple2LongOptionDouble](docs/Tuple2LongOptionDouble.md)\n - [UpdateCreateResult](docs/UpdateCreateResult.md)\n - [UpdateFleet](docs/UpdateFleet.md)\n - [UpdateHibernationStatusRequest](docs/UpdateHibernationStatusRequest.md)\n - [UpdateRequest](docs/UpdateRequest.md)\n - [UpstreamEndpointErrorRepr](docs/UpstreamEndpointErrorRepr.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"BearerAuth\"></a>\n### BearerAuth\n\n- **Type**: Bearer authentication\n\n<a id=\"Oauth2\"></a>\n### Oauth2\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: \n - **profile**: Default scope; automatically added and not currently used.\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Torizon OTA",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" torizon ota"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2caa8131b64235a399c0d1ebff497deb53e7862af6906ad1d9903a3c4869821a",
"md5": "36ff0167c602c97bf77b532e3405364e",
"sha256": "9c0c0ea9a79ac296d4fc021e8c156d1b3355e9f10bd624f9c81a45b64958a4f5"
},
"downloads": -1,
"filename": "torizon_io_api-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36ff0167c602c97bf77b532e3405364e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 140077,
"upload_time": "2024-12-21T02:46:35",
"upload_time_iso_8601": "2024-12-21T02:46:35.064261Z",
"url": "https://files.pythonhosted.org/packages/2c/aa/8131b64235a399c0d1ebff497deb53e7862af6906ad1d9903a3c4869821a/torizon_io_api-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "421685abaa4d85df674c1fcba8880595f55ab13d433a23f39e01e9e8c25759d2",
"md5": "2573f73e94a9c2443a05aa0a1123ce98",
"sha256": "e6b584b62ed23b67b6d2e97f0034f781dd1658fdfc5dbae01d73b4ee52d96e10"
},
"downloads": -1,
"filename": "torizon_io_api-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "2573f73e94a9c2443a05aa0a1123ce98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 59285,
"upload_time": "2024-12-21T02:46:37",
"upload_time_iso_8601": "2024-12-21T02:46:37.823682Z",
"url": "https://files.pythonhosted.org/packages/42/16/85abaa4d85df674c1fcba8880595f55ab13d433a23f39e01e9e8c25759d2/torizon_io_api-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 02:46:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "torizon-io-api"
}
JSON
