Optional Hidden setting for Custom Fields #6523

Closed
opened 2025-12-29 19:41:58 +01:00 by adam · 4 comments
Owner

Originally created by @sol1-matt on GitHub (Jun 1, 2022).

NetBox version

v3.2.1

Feature type

New functionality

Proposed functionality

Add a checkbox to custom fields Hidden that will hide the field in the UI, essentially rendering it read only from a user perspective.

The field would appear, and be updatable, in the api.

Allow these fields to able to be modified in conjunction with Custom Validation.

eg: a device name gets custom validated according to the required spec (lowercase, [0-9,a-z] only and unique) and stored in the hidden custom field.

Use case

Allows Netbox to maintain data related to a object without cluttering up the UI.

This would be useful for any external systems that currently use slugs to implement a replacement key to safely address and reference objects according to their needs meaning Netbox would not need to maintain slugs any more (#8113).

The combination of hidden custom field and functionality in custom validator to update the field value means the custom field becomes a unique key meeting the specific requirements of Netbox integrators that is validated at entry time and maintained by the source of truth.

Database changes

New boolen field on extras/custom-fields hidden.

External dependencies

No response

Originally created by @sol1-matt on GitHub (Jun 1, 2022). ### NetBox version v3.2.1 ### Feature type New functionality ### Proposed functionality Add a checkbox to custom fields `Hidden` that will hide the field in the UI, essentially rendering it read only from a user perspective. The field would appear, and be updatable, in the api. Allow these fields to able to be modified in conjunction with Custom Validation. eg: a device name gets custom validated according to the required spec (lowercase, [0-9,a-z] only and unique) and stored in the hidden custom field. ### Use case Allows Netbox to maintain data related to a object without cluttering up the UI. This would be useful for any external systems that currently use slugs to implement a replacement key to safely address and reference objects according to their needs meaning Netbox would not need to maintain slugs any more (#8113). The combination of hidden custom field and functionality in custom validator to update the field value means the custom field becomes a unique key meeting the specific requirements of Netbox integrators that is validated at entry time and maintained by the source of truth. ### Database changes New boolen field on `extras/custom-fields` `hidden`. ### External dependencies _No response_
adam added the type: featurestatus: duplicate labels 2025-12-29 19:41:58 +01:00
adam closed this issue 2025-12-29 19:41:58 +01:00
Author
Owner

@kkthxbye-code commented on GitHub (Jun 1, 2022):

Is this not covered by my PR here?

PR: https://github.com/netbox-community/netbox/pull/9411

3.3 changelog entry:

https://github.com/netbox-community/netbox/issues/9166 - Add UI visibility toggle for custom fields

@kkthxbye-code commented on GitHub (Jun 1, 2022): Is this not covered by my PR here? PR: https://github.com/netbox-community/netbox/pull/9411 3.3 changelog entry: > https://github.com/netbox-community/netbox/issues/9166 - Add UI visibility toggle for custom fields
Author
Owner

@kkthxbye-code commented on GitHub (Jun 1, 2022):

Duplicate of #9166

If I misread the request let me know and I'll reopen.

@kkthxbye-code commented on GitHub (Jun 1, 2022): Duplicate of #9166 If I misread the request let me know and I'll reopen.
Author
Owner

@DanSheps commented on GitHub (Jun 1, 2022):

Duplicate of #9166

@DanSheps commented on GitHub (Jun 1, 2022): Duplicate of #9166
Author
Owner

@sol1-matt commented on GitHub (Jun 2, 2022):

@kkthxbye-code
I think it is except for the ability of the custom validator to update it (which I suspect will already work but I haven't tested that), idk why I didn't see that when I checked. Apologies.

@sol1-matt commented on GitHub (Jun 2, 2022): @kkthxbye-code I think it is except for the ability of the custom validator to update it (which I suspect will already work but I haven't tested that), idk why I didn't see that when I checked. Apologies.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6523