Plugin system

1NCE OS Plugin System

📄️ Introduction

Documentation of the 1NCE OS API which can be used for managing the 1NCE OS Service.

📄️ Accept 1NCE OS Agreements

Post request to accept the 1NCE OS Terms of Use and Data Processing agreements. Please note that with this request the agreements can only be accepted.

📄️ Administration Logs

Administration Logs

📄️ Agreements

Agreements

📄️ Cancel all device action requests

Cancel all device action requests.

📄️ Cancel single device action request

Cancel single device action request.

📄️ Create Action Request On Specific CoAP Device.

Initiate CoAP action on specific device.

📄️ Create Action Request On Specific LwM2M Device.

Initiate LwM2M action like read, write, execute on specific device. It has to be connected to 1NCE LwM2M endpoint to invoke this event.

📄️ Create Action Request On Specific UDP Device.

Initiate UDP action on specific device.

📄️ Create Action Requests for CoAP Devices.

Initiate CoAP action on the devices.

📄️ Create Action Requests for LwM2M Devices.

Initiate LwM2M actions like read, write, execute on the specified devices. The devices have to be connected to 1NCE LwM2M endpoint to invoke this event.

📄️ Create Action Requests for UDP Devices.

Initiate UDP action on devices.

📄️ Create AWS Integration

Creates AWS Integration, which becomes active only after customer Cloudformation stack is rolled out.

📄️ Create geofence

Create a new geofence.

📄️ Create Optimizer Template

Create a new Translation Service Template.

📄️ Create Pre-Shared Device Key

Post a new Custom Pre-Shared Key for a specific Device.

📄️ Create Webhook Integration

Creates Webhook Integration.

📄️ Delete geofence

Delete a geofence.

📄️ Delete Integration

Delete Integration for a specific customer.

📄️ Delete Optimizer Template

Delete a specific Optimizer Template.

📄️ Device Inspector

Device Inspector

📄️ Device Locator

Device Locator

📄️ Devices

Devices

📄️ Get a geofence

Get details of a geofence.

📄️ Get a list of plugin installations

Retrieve a list of all installed plugins.

📄️ Get active device action requests

Get a list of active device action requests in the last 7 days.

📄️ Get Administration Log Payload

Get a URL pointing to a single administration log payload. The received URL will trigger a download.

📄️ Get Administration Logs Statistics

Get the administration logs statistics for the current organization.

📄️ Get Administration Logs

Get a list of the administration logs regarding the organization.

📄️ Get All Customer Integrations

Get All Customer Integrations details

📄️ Get All Devices

Get a list of all the Customer SIMs/Devices for the current organisation in the 1NCE OS.

📄️ Get all geofences

Get an overview of all geofences.

📄️ Get archived device action requests

Get a list of archived device action requests in the last 7 days.

📄️ Get CloudFormation Parameters

Get the URLs to download/rollout the customer CloudFormation stack templates.

📄️ Get Customer Integration

Get Customer Integration details

📄️ Get customer settings

Gets customer settings related to 1NCE OS.

📄️ Get details about a specific plugin installation

Retrieve details about a specific 1NCE OS plugin by it's installation ID.

📄️ Get device action requests

Get a list of device action requests in the last 7 days.

📄️ Get Device Celltower location resolutions

Get Cell location resolutions for one device (maximum of last 7 days).

📄️ Get device endpoints

Get details about the device endpoints.

📄️ Get Device Historian Insights

Get insights of a unique SIM device for the Historian.

📄️ Get Device Historian Messages

Get historic message data for a specific SIM device.

📄️ Get Device Positions

Get positions of a specific device (maximum of last 7 days).

📄️ Get Device Telemetry

Get the current/last repored Shadow State (telemetry) Data for a specific Device.

📄️ Get Devices Statistics

Get general statistics related to customer devices

📄️ Get Historian Insights

Get insights for all devices from the Historian based on the optional filters.

📄️ Get Historian Messages

Get a list of historic messages for devices based on the optional filter parameters.

📄️ Get Integration Event Types

Get Available Integration Event Types.

📄️ Get Latest Devices Positions

Get latest positions of customer devices (maximum of last 7 days). Only one latest position is possible for a single device independent of source: either Celltower or GPS. This means that `source` query parameter selection can lead to no latest position returned for some devices.

📄️ Get Optimizer Templates

Get all Translation Service Templates for the current organization.

📄️ Get Pre-Shared Device Key

Get the Pre-Shared Key of a specific Device.

📄️ Get savings

Get statistics about the savings by using the optimizer.

📄️ Get single device action request

Get details about the device action request.

📄️ Get single device endpoint

Get details about the device endpoint of a specific protocol.

📄️ Get Single Device

Get detailed metadata from one specific Device.

📄️ Import Pre-Shared Devices Keys

Import new Custom Pre-Shared Keys for multiple Devices.

📄️ Install Datacake plugin for 1NCE OS

Allows setting up an integration with Datacake workspace to allow data transfer from 1NCE OS.

📄️ Install Memfault plugin for 1NCE OS

Allows setting up an integration with Memfault to allow seamless device debugging via 1NCE OS CoAP proxy.

📄️ Install Mender plugin for 1NCE OS

Allows setting up an integration with Mender to allow seamless firmware update management via 1NCE OS CoAP proxy. Public and private keys are optional fields, but if they are used, both must be provided

📄️ Install Tartabit plugin for 1NCE OS

Allows setting up an integration with Tartabit to integrate with Azure, Oracle Cloud Infrastructure, Google Cloud and other cloud services via 1NCE OS.

📄️ IoT Integrator

IoT Integrator

📄️ Optimizer

Optimizer

📄️ Patch a geofence

Update an existing geofence

📄️ Patch Customer Integration

Patch Customer Integration

📄️ Patch Customer Webhook Integration

Patch Customer Webhook Integration

📄️ Patch Settings

Enables or disables different settings for the 1NCE OS integration of a customer.

📄️ Patch single device endpoint

Update endpoint related settings.

📄️ Plugin system

Plugin system

📄️ Pre-Shared Devices Keys Import Job Status

Get status of Pre-Shared Keys Import jobs for the last 30 days.

📄️ Restart a failed plugin by installation ID

Attempt to restart a plugin that is in a failed state.

📄️ Restart AWS Integration

Restart AWS integration by forwarding test message to the integration.

📄️ Restart Webhook Integration

Restart Webhook integration by forwarding test message to the integration.

📄️ Settings

Settings

📄️ Test AWS Integration

Test AWS integration by forwarding test message to the integration.

📄️ Test template

Test a template with a sample input message.

📄️ Test Webhook Integration

Test Webhook integration by forwarding test message to the integration.

📄️ Uninstall a specific plugin by ID

Uninstall a specific plugin by ID to remove the functionality provided by the plugin.

📄️ Update Optimizer Template

Update a specific Optimizer Template.