Support adding/modifying DataFiles via REST API #11530

New Issue

adam · 2025-12-29T21:46:27+01:00

adam commented

2025-12-29 21:46:27 +01:00

Originally created by @Tindarid on GitHub (Aug 26, 2025).

NetBox version

v4.3.6

Feature type

New functionality

Proposed functionality

Allow POST/PUT requests for DataFile endpoints: /api/core/data-files/
This will allow using DataFileLoader from https://github.com/netbox-community/netbox/blob/main/netbox/utilities/jinja2.py, meaning that we can create templates which reference other templates (extends/include/import Jinja2 statements) without defining DataSource

For example:

Having a directory of templates referencing each other, like here: https://github.com/jeremystretch/example-config-templates
new: Create DataFile object per file in the repository (specifying path/contents)
Create ConfigTemplate referencing master templates in the repository (in this example: access-switch.j2)
Rendering of access-switch.j2 works without defining DataSource

Use case

Would allow PUSH-ing templates with import capabilities, instead of PULL-ing them via defined data source: beneficial in certain infrastructure scenarios

Database changes

None: there is an unique constraint on Path already

External dependencies

N/A

Originally created by @Tindarid on GitHub (Aug 26, 2025). ### NetBox version v4.3.6 ### Feature type New functionality ### Proposed functionality - Allow POST/PUT requests for DataFile endpoints: `/api/core/data-files/` - This will allow using DataFileLoader from https://github.com/netbox-community/netbox/blob/main/netbox/utilities/jinja2.py, meaning that we can create templates which reference other templates (extends/include/import Jinja2 statements) without defining DataSource For example: * Having a directory of templates referencing each other, like here: https://github.com/jeremystretch/example-config-templates * new: Create DataFile object per file in the repository (specifying path/contents) * Create ConfigTemplate referencing master templates in the repository (in this example: `access-switch.j2`) * Rendering of `access-switch.j2` works without defining DataSource ### Use case Would allow PUSH-ing templates with import capabilities, instead of PULL-ing them via defined data source: beneficial in certain infrastructure scenarios ### Related - Solves: https://github.com/netbox-community/netbox/discussions/15505 - https://github.com/netbox-community/netbox/discussions/13602 - https://github.com/netbox-community/netbox/discussions/13575 ### Database changes None: there is an unique constraint on Path already ### External dependencies N/A

adam added the type: feature label 2025-12-29 21:46:27 +01:00

adam closed this issue

2025-12-29 21:46:27 +01:00

adam commented

2025-12-29 21:46:27 +01:00

@jeremystretch commented on GitHub (Aug 28, 2025):

I'm afraid your proposal exceeds the intended use case foe data files. Data files merely represent literal files served by a data source, and are entirely dependent on the data source as the authority governing what files exist and their contents. If you wish to add a new data file, that operation must take place in the data source itself (e.g. by pushing a new commit to a git-backed data source).

@jeremystretch commented on GitHub (Aug 28, 2025): I'm afraid your proposal exceeds the intended use case foe data files. Data files merely represent literal files served by a data source, and are entirely dependent on the data source as the authority governing what files exist and their contents. If you wish to add a new data file, that operation must take place in the data source itself (e.g. by pushing a new commit to a git-backed data source).

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#11530