Tag filtering in the API uses a tag's slug instead of its name #6771

New Issue

adam · 2025-12-29T19:45:14+01:00

adam commented

2025-12-29 19:45:14 +01:00

Originally created by @fabi125 on GitHub (Aug 4, 2022).

NetBox version

v3.2.7

Python version

3.8

Steps to Reproduce

https://demo.netbox.dev/api/dcim/devices/121/ has the following tags:

    "tags": [
        {
            "id": 1,
            "url": "https://demo.netbox.dev/api/extras/tags/1/",
            "display": "Alpha",
            "name": "Alpha",
            "slug": "alpha",
            "color": "aa1409"
        }
    ],

Expected Behavior

The only available filter in the api is tag= which I would expect takes a tag's name for filtering (or at least provide a way to provide the database id).

Given discussions like https://github.com/netbox-community/netbox/issues/8113 I wonder if using the slug here is the right thing.

Observed Behavior

https://demo.netbox.dev/api/dcim/devices/?tag=Alpha fails with

{
    "tag": [
        "Select a valid choice. Alpha is not one of the available choices."
    ]
}

But using the slug works: https://demo.netbox.dev/api/dcim/devices/?tag=alpha

Originally created by @fabi125 on GitHub (Aug 4, 2022). ### NetBox version v3.2.7 ### Python version 3.8 ### Steps to Reproduce https://demo.netbox.dev/api/dcim/devices/121/ has the following tags: ``` "tags": [ { "id": 1, "url": "https://demo.netbox.dev/api/extras/tags/1/", "display": "Alpha", "name": "Alpha", "slug": "alpha", "color": "aa1409" } ], ``` ### Expected Behavior The only available filter in the api is `tag=` which I would expect takes a tag's name for filtering (or at least provide a way to provide the database id). Given discussions like https://github.com/netbox-community/netbox/issues/8113 I wonder if using the slug here is the right thing. ### Observed Behavior https://demo.netbox.dev/api/dcim/devices/?tag=Alpha fails with ``` { "tag": [ "Select a valid choice. Alpha is not one of the available choices." ] } ``` But using the slug works: https://demo.netbox.dev/api/dcim/devices/?tag=alpha

adam closed this issue

2025-12-29 19:45:14 +01:00

adam commented

2025-12-29 19:45:15 +01:00

@jeremystretch commented on GitHub (Aug 8, 2022):

This is working as expected; tags are referenced in filters by their slugs.

@jeremystretch commented on GitHub (Aug 8, 2022): This is working as expected; tags are referenced in filters by their slugs.

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