You are here: Administration > Maintenance > Bulk import/export of device aliases

Bulk import/export of device aliases

Devices can register to Pexip Infinity using a permitted alias. If you want to configure your Pexip Infinity platform with a large number of device aliases you can import the configuration from a CSV file.

You can also export all of your existing device alias data to a CSV file. You may want to do this for backup purposes or to transfer configuration between, for example, a test system and a production system.

Preparing the CSV file for import

Header row

A header row in the CSV file is optional. If included, it should use exactly the same text for each field name as shown in the following section, although the order of the fields may vary.

Format

The data in the CSV file must use the following format, and fields must be in the same order as shown (unless you have used a header file):

alias,tag,description,username,password,primary_owner_email_address

where:

alias The alias URI with which the device must register to Pexip Infinity. The alias must be an exact match; regular expressions are not supported.
tag This optional field allows you to assign a unique identifier to this service, which you can then use to track use of the service. For more information, see Tracking usage with a service tag.
description An optional description of the device.
username

The username with which to authenticate the device. The credentials are optional and the device is not challenged if no credentials are entered.

password

The password with which to authenticate the device. The credentials are optional and the device is not challenged if no credentials are entered.

When passwords are exported to a CSV file, they will be encrypted. You can however re-import the encrypted form of the password and it will be saved as the original.

primary_owner_email_address The email address of the owner of the device alias. Device provisioning messages associated with this alias will be sent to this address.

Duplicates

If any records in the CSV file have the same alias field, only one device alias with that name will be created. This device alias will use the last record that was imported.

If any records in the CSV file have the same alias as an existing device alias, the existing configuration will be overwritten by the imported device alias's configuration.

Restrictions

  • The alias field cannot be blank.
  • All non-blank fields must contain valid data.
  • If non-ASCII characters are used, the file must be encoded as UTF-8 text.
  • All fields are case-sensitive.

Examples

alias,tag,description,username,password,sync_tag,primary_owner_email_address

To create aliases that will allow Alice and Bob to register their devices to Pexip Infinity with a username and password, you would create the following CSV file:

alice@example.com,,,alice,1234
bob@example.com,,,bob,5678

Importing the CSV file

To import the data in the CSV file to Pexip Infinity:

  1. On the Pexip Infinity Administrator interface, go to Service configuration > Device Aliases.
  2. From the bottom of the page, select Import.
  3. Choose the CSV file to import and select Save.

Exporting existing service configuration

You can export all of your existing device alias configuration data to a CSV file. This produces a CSV file in the same format as that used for importing configuration data (described above in Preparing the CSV file for import). The file includes a header row.

To export the data:

  1. On the Pexip Infinity Administrator interface, go to Service configuration > Device Aliases.
  2. From the bottom of the page, select Export. This takes you to the Export Device Alias configuration page.
  3. Select Download.
  4. Follow your browser's prompts to save or open the file.