starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add JSON/YAML import support for all objects #3464

New Issue
Closed
opened 2025-12-29 18:29:21 +01:00 by adam · 7 comments
adam commented 2025-12-29 18:29:21 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Mar 11, 2020).

Originally assigned to: @arthanson on GitHub.

Proposed Changes

Allow users to import objects in YAML or JSON format in addition to the existing support for CSV. YAML/JSON support was introduced for device types in #451; this extends that same functionality to all models.

Justification

JSON and YAML offer greater flexibility than CSV in incorporating related instances, as well as referencing parent objects.

Originally created by @jeremystretch on GitHub (Mar 11, 2020). Originally assigned to: @arthanson on GitHub. ### Proposed Changes Allow users to import objects in YAML or JSON format in addition to the existing support for CSV. YAML/JSON support was introduced for device types in #451; this extends that same functionality to all models. ### Justification JSON and YAML offer greater flexibility than CSV in incorporating related instances, as well as referencing parent objects.
adam added the status: acceptedtype: feature labels 2025-12-29 18:29:21 +01:00
adam closed this issue 2025-12-29 18:29:21 +01:00
adam commented 2025-12-29 18:29:21 +01:00
Author
Owner
Copy Link

@BarbarossaTM commented on GitHub (May 10, 2020):

This is really cool, thanks!

Are there any plans to allow import of a full export with multiple items (for examples device types) at once? This would be really awesome!

Thanks and best
Max

@BarbarossaTM commented on GitHub (May 10, 2020): This is really cool, thanks! Are there any plans to allow import of a full export with multiple items (for examples device types) at once? This would be really awesome! Thanks and best Max
adam commented 2025-12-29 18:29:21 +01:00
Author
Owner
Copy Link

@kjetilho commented on GitHub (Jul 6, 2021):

One use case for this feature: The changelog holds the JSON object for deleted objects, and it would be very convenient if this could be fed directly into an Import Device dialog to get an undo feature. (Since the JSON contains numeric ids for stuff like site or device_type, it is not so convenient to recreate the device by hand.)

@kjetilho commented on GitHub (Jul 6, 2021): One use case for this feature: The changelog holds the JSON object for deleted objects, and it would be very convenient if this could be fed directly into an Import Device dialog to get an undo feature. (Since the JSON contains numeric ids for stuff like `site` or `device_type`, it is not so convenient to recreate the device by hand.)
adam commented 2025-12-29 18:29:21 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 19, 2021):

Punting this to v3.2 as we'll likely need to refactor the current JSON/YAML import view substantially to accommodate models beyond device type.

@jeremystretch commented on GitHub (Oct 19, 2021): Punting this to v3.2 as we'll likely need to refactor the current JSON/YAML import view substantially to accommodate models beyond device type.
adam commented 2025-12-29 18:29:21 +01:00
Author
Owner
Copy Link

@sol1-matt commented on GitHub (Nov 14, 2021):

The import/export of device types already supports YAML but has limitations (discussion #6228). It works differently from normal import/export so don't know if would fall under the umbrella of this issue.

The ability to automatically create the linked objects is nice but the inability to bulk import isn't.

If there is to be a refactor consideration of device types would be useful.

@sol1-matt commented on GitHub (Nov 14, 2021): The import/export of device types already supports YAML but has limitations (discussion #6228). It works differently from normal import/export so don't know if would fall under the umbrella of this issue. The ability to automatically create the linked objects is nice but the inability to bulk import isn't. If there is to be a refactor consideration of device types would be useful.
adam commented 2025-12-29 18:29:22 +01:00
Author
Owner
Copy Link

@tom0010 commented on GitHub (Sep 2, 2022):

One use case for this feature: The changelog holds the JSON object for deleted objects, and it would be very convenient if this could be fed directly into an Import Device dialog to get an undo feature. (Since the JSON contains numeric ids for stuff like site or device_type, it is not so convenient to recreate the device by hand.)

Also looking for this type of thing.

In this release, would it be possible to do that via the API too?

@tom0010 commented on GitHub (Sep 2, 2022): > One use case for this feature: The changelog holds the JSON object for deleted objects, and it would be very convenient if this could be fed directly into an Import Device dialog to get an undo feature. (Since the JSON contains numeric ids for stuff like `site` or `device_type`, it is not so convenient to recreate the device by hand.) Also looking for this type of thing. In this release, would it be possible to do that via the API too?
adam commented 2025-12-29 18:29:22 +01:00
Author
Owner
Copy Link

@jsenecal commented on GitHub (Sep 2, 2022):

One use case for this feature: The changelog holds the JSON object for deleted objects, and it would be very convenient if this could be fed directly into an Import Device dialog to get an undo feature. (Since the JSON contains numeric ids for stuff like site or device_type, it is not so convenient to recreate the device by hand.)

Also looking for this type of thing.

In this release, would it be possible to do that via the API too?

What do you mean by "do that via the API too" ?

@jsenecal commented on GitHub (Sep 2, 2022): > > One use case for this feature: The changelog holds the JSON object for deleted objects, and it would be very convenient if this could be fed directly into an Import Device dialog to get an undo feature. (Since the JSON contains numeric ids for stuff like `site` or `device_type`, it is not so convenient to recreate the device by hand.) > > Also looking for this type of thing. > > In this release, would it be possible to do that via the API too? What do you mean by "do that via the API too" ?
adam commented 2025-12-29 18:29:22 +01:00
Author
Owner
Copy Link

@tom0010 commented on GitHub (Sep 2, 2022):

Bulk import NetBox information in json format via the API as well as in the GUI.

In this issue, my understanding is that you could bulk import yaml AND json, therefore I am assuming it's just the GUI.
Even though yaml and json follow the same model as such, from how I am reading it, it seems like this is a just GUI functionality. So I'd like to have the ability to do that via the API too if possible.

@tom0010 commented on GitHub (Sep 2, 2022): Bulk import NetBox information in json format via the API as well as in the GUI. In this issue, my understanding is that you could bulk import yaml AND json, therefore I am assuming it's just the GUI. Even though yaml and json follow the same model as such, from how I am reading it, it seems like this is a just GUI functionality. So I'd like to have the ability to do that via the API too if possible.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3464
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?