API docs by Redocly

Device Service - API Overview

Download OpenAPI specification:Download

API Overview

This API overview provides a detailed summary of tools for provisioning, managing, and integrating the Device Service, enabling secure device onboarding, bulk device management, and real-time status monitoring across communication and alarm services.

  1. Individual Device Provisioning API

    The Individual Device Provisioning API allows for adding, modifying, and deleting individual devices within a specified domain. This API is essential for maintaining device records, setting service-specific configurations, and ensuring each device is authenticated and configured to access the iotcomms.io services.

    • Main Endpoint

      • POST, PUT, DELETE

        /provisioning/device/{domain}: This endpoint manages individual device operations:

        • POST

          Adds a new device to the specified domain, configuring details like device ID, credentials, and any service-specific settings.

        • PUT

          Updates an existing device's settings within the domain, enabling adjustments to configurations, credentials, and other details as needed.

        • DELETE

          Deletes a device from the domain, fully removing it from the system and ending its service access.

  2. Bulk Device Provisioning API

    The Bulk Device Provisioning API streamlines the setup process for large-scale deployments, allowing administrators to provision multiple devices simultaneously. This feature is particularly useful for onboarding extensive device networks with ease and efficiency.

    • Main Endpoint

      • POST

        /provisioning/device/{domain}/bulk/{bulkId}: Accepts a batch of devices within a single request. Each device batch is assigned a bulkId, which simplifies tracking and management. This endpoint also supports CSV-based imports, which minimizes manual configuration by allowing bulk uploads.

These API endpoints are designed for flexible and scalable device management, enabling both precise individual control and efficient bulk operations. Together, they provide a comprehensive toolkit for securely onboarding, configuring, and maintaining large device fleets across iotcomms.io services.