Import entities into the Address Manager database by uploading a CSV or NDJSON file of entities.
API method: POST /v1/importEntities
- You must be an Address Manager administrator to use this method.
- Ensure that the formatting of your import files matches the examples exactly, as the importEntities method is case sensitive.
- UDFs are supported but must exist in Address Manager first. Ensure that you have created necessary UDFs in Address Manager before uploading files with UDF values.
- If a UDF for an entity exists in Address Manager, but the UDF value is not
provided in the importEntities file, the API will not apply a
value automatically. The field will be processed as empty
null), even if a default value has been configured when creating the UDF. Therefore if a UDF is required, a value must be provided in the importEntities file or the import will fail, even if a default value has been configured.
The following entity types are supported for import: IP4Address, IP4Block, IP4DHCPRange, IP4Network, MACAddress.
importEntities uses newline delimited JSON (NDJSON). For more information on the NDJSON format, refer to http://ndjson.org/.
For examples of valid CSV and NDJSON files that can be imported, refer to the following reference sections: