is_api_request() returns False if content type is not set to "application/json" #11437

New Issue

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

adam commented

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

Originally created by @jeremystretch on GitHub (Aug 1, 2025).

Originally assigned to: @jeremystretch on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.3.5

Python Version

3.10

Steps to Reproduce

Make a REST API GET request without specifying a content type:

curl -v -X GET \
-H "Authorization: Token $TOKEN" \
-H "Accept: application/json; indent=4" \
http://netbox:8000/api/status/

Inspect the response headers.

Expected Behavior

The response should include an API-Version header indicating the NetBox version. This can be verified by re-sending the above request with a Content-Type header:

curl -v -X GET \
-H "Authorization: Token $TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json; indent=4" \
http://netbox:8000/api/status/

Observed Behavior

The API-Version header is missing from the response.

The is_api_request() utility function is intended to return True for any request which qualifies as consuming the REST API. However, this happens only if the request has specified a Content-Type of application/json:

c7b68664f9/netbox/utilities/api.py (L55-L60)

The content type should not be a condition of qualifying as an API request.

Originally created by @jeremystretch on GitHub (Aug 1, 2025). Originally assigned to: @jeremystretch on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.3.5 ### Python Version 3.10 ### Steps to Reproduce 1. Make a REST API `GET` request without specifying a content type: ``` curl -v -X GET \ -H "Authorization: Token $TOKEN" \ -H "Accept: application/json; indent=4" \ http://netbox:8000/api/status/ ``` 2. Inspect the response headers. ### Expected Behavior The response should include an `API-Version` header indicating the NetBox version. This can be verified by re-sending the above request with a `Content-Type` header: ``` curl -v -X GET \ -H "Authorization: Token $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json; indent=4" \ http://netbox:8000/api/status/ ``` ### Observed Behavior The `API-Version` header is missing from the response. The `is_api_request()` utility function is intended to return True for any request which qualifies as consuming the REST API. However, this happens only if the request has specified a `Content-Type` of `application/json`: https://github.com/netbox-community/netbox/blob/c7b68664f9e48c0d70b18f4da8ae2c59b0c26e99/netbox/utilities/api.py#L55-L60 The content type should not be a condition of qualifying as an API request.

adam added the type: bug status: accepted severity: low labels 2025-12-29 21:45:14 +01:00

adam closed this issue

2025-12-29 21:45:15 +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#11437

is_api_request() returns False if content type is not set to "application/json" #11437