Skip to main content

Data Sources

A data source represents some external repository of data which NetBox can consume, such as a git repository. Files within the data source are synchronized to NetBox by saving them in the database as data file objects.

Fields

Name

The data source's human-friendly name.

Type

The type of data source. Supported options include:

  • Local directory
  • git repository
  • Amazon S3 bucket

URL

The URL identifying the remote source. Some examples are included below.

TypeExample URL
Localfile:///path/to/my/data/
githttps://github.com/my-organization/my-repo
Amazon S3https://s3.us-east-2.amazonaws.com/my-bucket-name/

Status

The source's current synchronization status. Note that this cannot be set manually: It is updated automatically when the source is synchronized.

Enabled

If false, synchronization will be disabled.

Ignore Rules

A set of rules (one per line) identifying filenames to ignore during synchronization. Some examples are provided below. See Python's fnmatch() documentation for a complete reference.

RuleDescription
READMEIgnore any files named README
*.txtIgnore any files with a .txt extension
data???.jsonIgnore e.g. data123.json

Sync Interval

This field was introduced in NetBox v4.3.

The interval at which the data source should automatically synchronize. If not set, the data source must be synchronized manually.

Last Synced

The date and time at which the source was most recently synchronized successfully.