Filter results by

Approved List

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 both for securely registered device types and for ordinary device types. Device types that are not securely registered need a public X.509 certificate in order to be added to an Approved List. See Add a certificate.

Approved Lists 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.

ARTIK cloud services Approved List

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.

ARTIK cloud services Approved List

Upload an Approved List

An Approved List of devices is uploaded to ARTIK cloud services as a CSV file.

ARTIK cloud services Approved List

  • Include the header "vdid" in the CSV file. Each value listed under this header represents a vendor device ID (vdid), a unique identifier your organization generates for each device.
    • vdid can have up to 64 characters.
    • vdid cannot contain spaces or special characters (except for "_" and "-").
    • vdid cannot 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.

A vdid could be one of the following:

  • MAC/EUI
  • 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.

ARTIK cloud services Approved List

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 vdid.

Check status of upload

The Dashboard shows the status of your last upload.

ARTIK cloud services Approved List

Once a new upload is started, the status of the previous upload is replaced.

Add a certificate

This step is not needed for securely registered device types.

A device type that is not securely registered must have a public X.509 certificate.

To generate a certificate for the device type, do the following.

Generate a private key for your device type certificate with the following command:

1
openssl genrsa -out rootCA.key

Use the private key from the key pair to generate a root CA certificate for all devices of this device type:

1
openssl req -x509 -new -nodes -key rootCA.key -out rootCA.pem -days 500 -sha256

You will be asked to enter information that will be incorporated in your certificate request.

These commands will vary according to your use case and security requirements. In the above command, we include -sha256 to use the strong SHA-2 hash functions and -days 500 to define a certificate expiration date of 500 days.

Upload the certificate on the Approved List page as follows.

ARTIK cloud services Approved List

Only one certificate can be uploaded per device type. You can view the details of the certificate or delete the certificate in the Dashboard.

ARTIK cloud services Approved List

After you enable the Approved List, upload the Approved List, and add the certificate for a device type that is not securely registered, when using the API to create a device for this device type, you must pass two additional request parameters vdid and svdid. Refer to the API reference for details.

1
2
3
4
5
6
7
{
  "dtid": "dta8a02005a5854c11b224997e2705e3cc",
  "name": "deviceType",
  "uid": "bb04ee8da64a4d85bf36c38b154b7df3",
  "vdid": "device_vdid1",
  "svdid": "eStQL1j2lGQykLcFfmLS/67D2LDBrx1hQsIsA2vXMUymj5z/CA6ROQ5tmjQSXFoRhhHghmZo4+rBBx7Ja4NMaJ4S8APnr8z7CG6pkvhF7mZ2VHWmDSN6ISGfpfsuYh47on1SF8efBh4cA=="
}

Approved List API reference

You can manage Approved Lists programmatically using the APIs. These are documented in our API reference.