guest
User
Profile Bookmarks Subscriptions Preferences API Tokens
Log Out

Custom Field Bulk Import

Enter object data in CSV, JSON or YAML format.
This field is required.
The character which delimits CSV fields. Applies only to CSV format.
Cancel
This field is required.
The character which delimits CSV fields. Applies only to CSV format.
Cancel
This field is required.
The character which delimits CSV fields. Applies only to CSV format.
Cancel

Field Options

Field Required Accessor Description
name — Internal field name
type — Field data type (e.g. text, integer, etc.)
object_types — One or more assigned object types
search_weight — Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
filter_logic — Loose matches any instance of a given string; exact matches the entire field.
weight — Fields with higher weights appear lower in a form.
label — — Name of the field as displayed to users (if not provided, 'the field's name will be used)
group_name — — Custom fields within the same group will be displayed together
related_object_type — — Object type (for object or multi-object fields)
required — — This field is required when creating new objects or editing an existing object.
Specify true or false
unique — — The value of this field must be unique for the assigned object
Specify true or false
description — — Description
default — — Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
choice_set — name Choice set (for selection fields)
validation_minimum — — Minimum allowed value (for numeric fields)
validation_maximum — — Maximum allowed value (for numeric fields)
validation_regex — — Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters.
ui_visible — — Whether the custom field is displayed in the UI
ui_editable — — Whether the custom field is editable in the UI
is_cloneable — — Replicate this value when cloning objects
Specify true or false
comments — — Comments
id — — Numeric ID of an existing object to update (if not creating a new object)

Required fields must be specified for all objects.

Related objects may be referenced by any unique attribute. For example, vrf.rd would identify a VRF by its route distinguisher.