System page - Server Error if Custom Validation Logic is used #10122

New Issue

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

adam commented

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

Originally created by @moseisleydk on GitHub (Aug 20, 2024).

Originally assigned to: @arthanson on GitHub.

Deployment Type

Self-hosted

NetBox Version

4.0.9

Python Version

3.11

Steps to Reproduce

This is also described at https://github.com/netbox-community/netbox/discussions/17214

If I in configuration.py add a custom validator like:

from extras.validators import CustomValidator

class UniqueSerial(CustomValidator):

    def validate(self, instance):
        from dcim.models import Device

        if instance.serial and Device.objects.exclude(pk=instance.pk).filter(serial=instance.serial).exists():
            self.fail("The Serial number already exists in NetBox", field='serial')

CUSTOM_VALIDATORS = {
    'dcim.device': (
        UniqueSerial(),
    )
}

the menu item "Sytem" at /core/system/ fails with:

Object of type UniqueSerial is not JSON serializable

Python version: 3.11.6
NetBox version: 4.0.9
Plugins:
netbox_secrets: 2.0.3
netbox_topology_views: 4.0.0

Expected Behavior

The page should be rendered correct and show system data.

Observed Behavior

If I remove

CUSTOM_VALIDATORS = { 'dcim.device': ( UniqueSerial(), ) }

from configuration.py, the page renders nicely

if seems to me that the page render tries to see UniqueSerial() as a json, and not code

Originally created by @moseisleydk on GitHub (Aug 20, 2024). Originally assigned to: @arthanson on GitHub. ### Deployment Type Self-hosted ### NetBox Version 4.0.9 ### Python Version 3.11 ### Steps to Reproduce This is also described at https://github.com/netbox-community/netbox/discussions/17214 If I in configuration.py add a custom validator like: ``` from extras.validators import CustomValidator class UniqueSerial(CustomValidator): def validate(self, instance): from dcim.models import Device if instance.serial and Device.objects.exclude(pk=instance.pk).filter(serial=instance.serial).exists(): self.fail("The Serial number already exists in NetBox", field='serial') CUSTOM_VALIDATORS = { 'dcim.device': ( UniqueSerial(), ) } ``` the menu item "Sytem" at /core/system/ fails with: Object of type UniqueSerial is not JSON serializable Python version: 3.11.6 NetBox version: 4.0.9 Plugins: netbox_secrets: 2.0.3 netbox_topology_views: 4.0.0 ### Expected Behavior The page should be rendered correct and show system data. ### Observed Behavior If I remove `CUSTOM_VALIDATORS = { 'dcim.device': ( UniqueSerial(), ) }` from configuration.py, the page renders nicely if seems to me that the page render tries to see UniqueSerial() as a json, and not code

adam added the type: bug status: accepted severity: medium labels 2025-12-29 21:27:09 +01:00

adam closed this issue

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

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#10122