Add a JSON custom field type #5473

Closed
opened 2025-12-29 19:28:27 +01:00 by adam · 1 comment
Owner

Originally created by @jeremystretch on GitHub (Oct 5, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.0.5

Feature type

New functionality

Proposed functionality

Add a new custom field type to store JSON data directly on an object. The name of this type would be json. Given that custom field data is already stored in JSON format, this should be easy to implement.

Use case

Allows the addition of structured custom data that may not make sense to manage as multiple fields. For example, an external system might attach the most recent results of some validation testing.

This was first proposed (AFAIK) in #6711.

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Oct 5, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.0.5 ### Feature type New functionality ### Proposed functionality Add a new custom field type to store JSON data directly on an object. The name of this type would be `json`. Given that custom field data is already stored in JSON format, this should be easy to implement. ### Use case Allows the addition of structured custom data that may not make sense to manage as multiple fields. For example, an external system might attach the most recent results of some validation testing. This was first proposed (AFAIK) in #6711. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 19:28:27 +01:00
adam closed this issue 2025-12-29 19:28:28 +01:00
Author
Owner

@MalfuncEddie commented on GitHub (Oct 20, 2021):

This feature would be helpful to update certain info that has no place in a custom field. In my use case I would like to store a subset of ansible facts in netbox. But I am a bit worried that json data would clutter the UI. Maybe add the option to hide it and make it only api vissible?

@MalfuncEddie commented on GitHub (Oct 20, 2021): This feature would be helpful to update certain info that has no place in a custom field. In my use case I would like to store a subset of ansible facts in netbox. But I am a bit worried that json data would clutter the UI. Maybe add the option to hide it and make it only api vissible?
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5473