Device Import

Device Import

Device Import lets you create devices in bulk in /IOTCONNECT™ by uploading a JSON file. Instead of registering devices one at a time, you upload a batch file, validate it, and the platform provisions every device under a chosen template — including gateway devices and their child devices.

Overview

Device Import is a bulk device provisioning feature. You upload a JSON file describing the devices you want to create, the platform validates the file, and once validated you trigger the import. Device creation then runs as a background job so large batches do not block your session.

What you can import:

Standalone devices: A flat list of devices created under a single device template.

Gateway devices: Gateway (parent) devices created in bulk from the same file.

Child devices: Child devices nested under their gateway device directly in the JSON file.

How it works: The import runs in two phases — a validate phase that checks the file and reports success and failure counts, and an import phase that provisions the validated devices through a background batch job.

How It Works

A device import moves through the following stages:

1. Select import type and template: Pick an import type and the device template under which the devices will be created.

2. Upload and validate: Upload the JSON file. The platform parses the file, checks every device entry, and records how many entries passed and failed. The batch status becomes Validated.

3. Trigger import: Confirm the import. The platform verifies the batch is validated, checks your device quota, and queues a background batch-import job. The status moves to In Queue.

4. Background processing: The batch job creates each device. The status reflects In Progress while running.

5. Monitor results: Review the batch list for per-batch success and failure counts, and open a batch to see the result for each individual device.

Import Batch Status

Each import batch reports one of the following statuses as it progresses:

Uploaded: The file has been uploaded and accepted for processing.

Validated: The file passed validation and is ready to import. Import can only be triggered from this state.

In Queue: The import has been queued for background processing.

In Progress: The background job is actively creating devices.

Failed: The batch could not be processed.

Device Quota

Every account has a device quota that limits the total number of devices you can create, including devices added through import.

Default limit: By default, an account can hold up to 10,000 devices.

Checked before import: When you trigger an import, the platform adds the number of devices in the batch to your current device count. If the total would exceed your quota, the import is blocked and no devices are created.

Need more? If you need to go beyond 10,000 devices, create a support ticket to request a higher quota. Once approved, your limit is increased and you can import the additional devices.

File Requirements and Validation

The import file must be a valid JSON file that follows the sample format available in your /IOTCONNECT™ account. The platform rejects the batch if any of these rules are not met:

The file must be valid JSON and contain the required gateway and meta sections.

A device template code (dtCode) or software template code (stCode) is required and must be valid.

Every device uniqueId is required and must be unique — duplicates are not allowed for parent devices, nor for child devices within the same parent.

A uniqueId cannot contain spaces or special characters (only letters, digits, and hyphens are allowed) and cannot be the literal text “uniqueId”.

Length limits apply by auth type: self or CA-signed parent uniqueId ≤ 31 characters, self or CA-signed child uniqueId ≤ 64 characters, and TPM / Key device uniqueId ≤ 128 characters.

If a device includes properties, each property key is required and duplicate property keys are not allowed. A tag is required for gateway child devices.

ⓘ NOTE

A batch can only be imported after it reaches the Validated status. The default device quota is 10,000 devices — if an import would exceed it, the import is blocked. To raise the limit, create a support ticket and the quota will be increased. Always download the sample file from your /IOTCONNECT™ account to match the expected JSON structure.