Skip to content
/ torizon-openapi-powershell Public

Torizon Cloud API PowerShell code generated from OpenAPI specification

1 star 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

commontorizon/torizon-openapi-powershell

BranchesTags

Repository files navigation

TorizonPlatformAPI - the PowerShell module for the Torizon OTA

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 PowerShell module is automatically generated by the OpenAPI Generator project:

  • API version: 2.0-Beta
  • SDK version: 0.2.2
  • Generator version: 7.8.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

  • PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\TorizonPlatformAPI' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\TorizonPlatformAPI' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "TorizonPlatformAPI"; ModuleVersion = "0.2.2"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

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

Class Method HTTP request Description
TorizonPlatformAPIDeviceMetricsApi Get-TorizonPlatformAPIDeviceDataDevicesDeviceuuidMetrics GET /device-data/devices/{deviceUuid}/metrics Get metrics data from a single device
TorizonPlatformAPIDeviceMetricsApi Get-TorizonPlatformAPIDeviceDataFleetsFleetidMetrics GET /device-data/fleets/{fleetId}/metrics Get aggregated metrics data from a fleet of devices
TorizonPlatformAPIDeviceMetricsApi Get-TorizonPlatformAPIDeviceDataMetricNames GET /device-data/metric-names Get the list of metrics available in your repository
TorizonPlatformAPIDevicesApi Invoke-TorizonPlatformAPIDeleteDevicesDeviceuuid DELETE /devices/{deviceUuid} Delete a single device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevices GET /devices Query device information
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesDeviceuuid GET /devices/{deviceUuid} Get detailed information about a single device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesNameDeviceuuid GET /devices/name/{deviceUuid} Get the display name of a single device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesNetwork GET /devices/network Get network information for many devices
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesNetworkDeviceuuid GET /devices/network/{deviceUuid} Get network information for a single device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesNotesDeviceuuid GET /devices/notes/{deviceUuid} Get the device notes for a specific device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesPackages GET /devices/packages Get information about the installed packages for many devices
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesPackagesDeviceuuid GET /devices/packages/{deviceUuid} Get information about the installed packages for a single device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesToken GET /devices/token Retrieve device provisioning token
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesUptaneDeviceuuidAssignment GET /devices/uptane/{deviceUuid}/assignment Show detailed information about the currently-assigned update for a single device
TorizonPlatformAPIDevicesApi Get-TorizonPlatformAPIDevicesUptaneDeviceuuidComponents GET /devices/uptane/{deviceUuid}/components Get a list of the software components reported by a single device
TorizonPlatformAPIDevicesApi Submit-TorizonPlatformAPIDevices POST /devices Manually create a new device
TorizonPlatformAPIDevicesApi Send-TorizonPlatformAPIDevicesNameDeviceuuid PUT /devices/name/{deviceUuid} Set the display name of a single device
TorizonPlatformAPIDevicesApi Send-TorizonPlatformAPIDevicesNotesDeviceuuid PUT /devices/notes/{deviceUuid} Set the device notes for a specific device
TorizonPlatformAPIFleetsApi Invoke-TorizonPlatformAPIDeleteFleetsFleetid DELETE /fleets/{fleetId} Delete a fleet
TorizonPlatformAPIFleetsApi Invoke-TorizonPlatformAPIDeleteFleetsFleetidDevices DELETE /fleets/{fleetId}/devices Remove devices from a fleet
TorizonPlatformAPIFleetsApi Get-TorizonPlatformAPIFleets GET /fleets Get information about all fleets in your repository
TorizonPlatformAPIFleetsApi Get-TorizonPlatformAPIFleetsFleetidDevices GET /fleets/{fleetId}/devices Get information about the devices in a single fleet
TorizonPlatformAPIFleetsApi Submit-TorizonPlatformAPIFleets POST /fleets Create a new fleet
TorizonPlatformAPIFleetsApi Submit-TorizonPlatformAPIFleetsFleetidDevices POST /fleets/{fleetId}/devices Add devices to a fleet
TorizonPlatformAPIPackagesApi Invoke-TorizonPlatformAPIDeletePackagesPackageid DELETE /packages/{packageId} Delete a package
TorizonPlatformAPIPackagesApi Get-TorizonPlatformAPIPackages GET /packages Retrieve metadata about packages in your repository
TorizonPlatformAPIPackagesApi Get-TorizonPlatformAPIPackagesExternal GET /packages_external Retrieve metadata about packages in your repository from other sources
TorizonPlatformAPIPackagesApi Get-TorizonPlatformAPIPackagesExternalInfo GET /packages_external/info Fetch information about external package sources
TorizonPlatformAPIPackagesApi Get-TorizonPlatformAPIPackagesExternalRefreshSourceFileName GET /packages_external/refresh/{source_file_name} Refresh metadata from an external package source
TorizonPlatformAPIPackagesApi Invoke-TorizonPlatformAPIPatchPackagesPackageid PATCH /packages/{packageId} Edit metadata about a package
TorizonPlatformAPIPackagesApi Submit-TorizonPlatformAPIPackages POST /packages Upload a new package
TorizonPlatformAPIUpdatesApi Get-TorizonPlatformAPILockboxDetails GET /lockbox-details List all existing lockboxes on the repository, and their detailed contents
TorizonPlatformAPIUpdatesApi Get-TorizonPlatformAPILockboxes GET /lockboxes List all existing lockboxes on the repository
TorizonPlatformAPIUpdatesApi Get-TorizonPlatformAPILockboxesLockboxName GET /lockboxes/{lockbox_name} Get the raw Uptane metadata for a lockbox
TorizonPlatformAPIUpdatesApi Invoke-TorizonPlatformAPIPatchUpdates PATCH /updates Cancel a pending update for one or more devices
TorizonPlatformAPIUpdatesApi Submit-TorizonPlatformAPILockboxesLockboxName POST /lockboxes/{lockbox_name} Define a new lockbox, or update an existing one
TorizonPlatformAPIUpdatesApi Submit-TorizonPlatformAPIUpdates POST /updates Launch an update to one or more devices or fleets

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer Token authentication

About

Torizon Cloud API PowerShell code generated from OpenAPI specification

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

3 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages