API does not accept url encoded query strings #1710

New Issue

adam · 2025-12-29T16:34:38+01:00

adam commented

2025-12-29 16:34:38 +01:00

Originally created by @wrouesnel on GitHub (Apr 30, 2018).

Issue type

[x] Bug report

Environment

Python version: 3.6.5
NetBox version: 75465a340476 (v2.3.3)

Description

Try querying a device type using the regular query syntax with a simple URL:
/api/dcim/device-types/?q=&slug=unknown model

Result - it'll work

Try the same query with a properly URL encoded string as produced by requests for example:
/api/dcim/device-types/?q=&slug=unknown%20model

Result - no results. A totally different query.

To make this query work I have to intentionally send malformed requests to the endpoint when using requests:

greq = requests.Request(method='GET', url=netbox_uri + '/api/dcim/device-types/')
prep = greq.prepare()
prep.url = netbox_uri + '/api/dcim/device-types/' + '?q=&slug={}'.format('unknown model')
r = s.send(prep)

Which is obviously far from ideal.

Originally created by @wrouesnel on GitHub (Apr 30, 2018). ### Issue type [x] Bug report   ### Environment * Python version: 3.6.5 * NetBox version: 75465a340476 (v2.3.3)  ### Description Try querying a device type using the regular query syntax with a simple URL: `/api/dcim/device-types/?q=&slug=unknown model` Result - it'll work Try the same query with a properly URL encoded string as produced by requests for example: `/api/dcim/device-types/?q=&slug=unknown%20model` Result - no results. A totally different query. To make this query work I have to intentionally send malformed requests to the endpoint when using requests: ``` greq = requests.Request(method='GET', url=netbox_uri + '/api/dcim/device-types/') prep = greq.prepare() prep.url = netbox_uri + '/api/dcim/device-types/' + '?q=&slug={}'.format('unknown model') r = s.send(prep) ``` Which is obviously far from ideal.

adam closed this issue

2025-12-29 16:34:38 +01:00

adam commented

2025-12-29 16:34:38 +01:00

@jeremystretch commented on GitHub (Jul 5, 2018):

Slugs generally use hyphens instead of spaces to avoid this problem. That said, NetBox relies on django-filter for query filtering, so any requests for changes to this behavior would need to be submitted against that project.

@jeremystretch commented on GitHub (Jul 5, 2018): Slugs generally use hyphens instead of spaces to avoid this problem. That said, NetBox relies on [django-filter](https://github.com/carltongibson/django-filter) for query filtering, so any requests for changes to this behavior would need to be submitted against that project.

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