You can choose which devices are allowed to register under your device type. These devices are uploaded to ARTIK cloud services in an Approved List. You can do this in the Developer Dashboard or via the APIs listed at the end of this article.
The ability to add an Approved List is supported for public, private, and protected device types and can be used with any pricing plan. Adding an Approved List is not available for Cloud Connectors at this time.
Enable an Approved List
By default, an Approved List is not enabled when a device type is created. To set up an Approved List for a device type, click Approved List in the menu for that device type.
An Approved List can be enabled only if no devices are registered under the device type. This applies even if you have disabled an Approved List after it was previously enabled. Approved Lists can be disabled at any time.
Upload an Approved List
An Approved List of devices is uploaded to ARTIK cloud services as a CSV file.
- Include the header
vdidin the CSV file. This represents the vendor device ID, a unique identifier your organization generates for each device.
vdidcan have up to 64 characters.
vdidcannot contain spaces or special characters (except for "
_" and "
vdidcannot be empty/null.
- A CSV file can include a maximum of 10,000 vendor device IDs. Files with more than 10,000 will be rejected.
vdid could be one of the following:
- Module type identifier
- Serial number
- Any string matching the above requirements.
Example CSV file
1 2 3 4 5 6 7 8 vdid 762kjhadjhg-akdbj_lknasd0ks-lkalsd 762kadmshhg-akdbj_lkna2iq0ks-lkalsd 762kjhadjhg-akdbj_lknasasdmnbn0ks-lkalsd 762kjhadjhg-akdbj_lknasdmnbd0ks-lkalsd asd-akdbj_lknasd0ks-lkalsd asdhjga-akdbj_lknasd0ks-lkalsd 762kjhadasdnmaakdbj_lknasd0ks-lkalsd
One CSV file can be uploaded at a time. After the upload finishes, you can view the list of devices in the Dashboard.
This page shows:
- Vendor device ID
- Device ID
- Timestamp for the finished upload, identical for all vendor device IDs in the same CSV file
You can use the API to search devices by
Check status of upload
The Dashboard shows the status of your last upload.
Once a new upload is started, the status of the previous upload is replaced.
Add a certificate
A device type that is not securely registered must have a public X.509 certificate.
Follow these steps to generate a certificate for the device type. Then upload the certificate on the Approved List page as follows.
Only one certificate can be uploaded per device type. You can view the details of the certificate or delete the certificate in the Dashboard.
Approved List API reference
You can manage Approved Lists programmatically using the APIs. These are documented in our API reference.
- Upload an Approved List
- Check Approved List upload status
- Get rejected device rows
- Get a device type's Approved List
- Remove device from Approved List
- Enable/disable Approved List for a device type
- Upload Approved List certificate
- Remove Approved List certificate from device type
- Check if device type is Approved
- Get Approved List certificate details
- Find a vendor device ID