Create Single Device

Use the following API to create or update one or more devices. Almost all devices require specifying an install_code field. The install code field is the secure password printed on the device label. If you don’t have the install code, the device cannot be registered to your account.

The initial step of adding the device to your account is commonly called “provisioning” or “to provision” a device.

The request payload can include a single device or multiple devices. Multiple devices must be wrapped in an array for JSON. The response always returns the devices as a list.

The following sample JSON request creates a device with various settings. Most of the settings available in the Get Single Device page can be specified.

Request

POST /ws/v1/devices/inventory?bundle_device=true

Payload:

{
  "id": "00000000-00000000-0040FFFF-FF8001B0",
  "install_code": "device-default-password-from-label",
  "name": "Deadpool",
  "tags" : ["Marvel","AntiHero"],
  "group": "ExampleGroup",
}

Response

{
    "count": 1,
    "list": [
        {
            "channels_uri": "/ws/v1/devices/channels/00000000-00000000-0040FFFF-FF8001B0",
            "connection_status": "disconnected",
            "customer_id": 57639,
            "firmware_status": "not_identified",
            "group": "ExampleGroup",
            "health_status": "unknown",
            "id": "00000000-00000000-0040FFFF-FF8001B0",
            "in_maintenance_window": "yes",
            "mac": "00:40:FF:80:01:B1",
            "maintenance_mode": "off",
            "management_uri": "/ws/v1/devices/management/00000000-00000000-0040FFFF-FF8001B0",
            "metrics_uri": "/ws/v1/devices/metrics/00000000-00000000-0040FFFF-FF8001B0",
            "name": "Deadpool",
            "restricted_status": "unrestricted",
            "tags": [
                "Marvel",
                "AntiHero"
            ],
            "type": " "
        }
    ]
}

About the bundle_device parameter

bundle_device=true causes the API to register a device as a Digi 360 device (also known as Lifecycle Assurance). The device is provisioned into your Remote Manager account and registered in Digi’s ERP systems. You should use this option unless you have good reason not to. One direct benefit is that the your Remote Manager device limit will never prevent you from provisioning this device if it is a 360/LCA device. Adding devices through the Remote Manager web interface uses this same behavior.

Specifying your reseller

You can optionally add a reseller field in the HTTP body payload. The value of that field must be numerical. This will help Digi bill renewals through your reseller. You can find your reseller’s numerical ID by using the following API:

GET /ws/v1/billing/partners