Custom field filtering not working #2965

New Issue

adam · 2025-12-29T18:24:08+01:00

adam commented

2025-12-29 18:24:08 +01:00

Originally created by @havedill on GitHub (Oct 21, 2019).

Environment

Python version: 3.6.7
NetBox version: 2.6.6 (was also happening on 2.6.4)

Steps to Reproduce

Create a custom field in the admin panel. In my case it was a bool called Production
Attempt to query API with filter for field value of true or false
http://netbox.company.com/api/virtualization/virtual-machines/?cf_Production=false

I have tried this with both "loose" and "exact" filtering settings on the custom item.

I would expect hosts with the cf_Production value set as false to return.

When you do not try to do a cf_ query, you can see the values exist;

            "custom_fields": {
                "DNSAlias": null,
                "Production": false
            },

No return at all.

Originally created by @havedill on GitHub (Oct 21, 2019).  ### Environment * Python version: 3.6.7 * NetBox version: 2.6.6 (was also happening on 2.6.4) ### Steps to Reproduce 1. Create a custom field in the admin panel. In my case it was a **bool** called Production 2. Attempt to query API with filter for field value of true or false http://netbox.company.com/api/virtualization/virtual-machines/?cf_Production=false I have tried this with both "loose" and "exact" filtering settings on the custom item.  I would expect hosts with the cf_Production value set as false to return. When you do not try to do a cf_ query, you can see the values exist; ``` "custom_fields": { "DNSAlias": null, "Production": false }, ```  No return at all.

adam closed this issue

2025-12-29 18:24:08 +01:00

adam commented

2025-12-29 18:24:09 +01:00

@havedill commented on GitHub (Oct 22, 2019):

I found out why i was not getting returns.

For custom field querying of boolean values you need to search for a 1 or a 0. I was confused because i was expecting to filter for what i saw in the json netbox was returning. Perhaps the documentation should be updated to clarify this?

?cf_Production=1 works for True
?cf_Production=0 works for False

@havedill commented on GitHub (Oct 22, 2019): I found out why i was not getting returns. For custom field querying of boolean values you need to search for a 1 or a 0. I was confused because i was expecting to filter for what i saw in the json netbox was returning. Perhaps the documentation should be updated to clarify this? ?cf_Production=1 works for True ?cf_Production=0 works for False

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