OPTIONS requests for list API endpoints raises an exception #4364

New Issue

adam · 2025-12-29T18:35:14+01:00

adam commented

2025-12-29 18:35:14 +01:00

Originally created by @jeremystretch on GitHub (Dec 16, 2020).

Originally assigned to: @jeremystretch on GitHub.

Environment

Python version: 3.6.9
NetBox version: 2.10.0

Steps to Reproduce

Make an OPTIONS request to a REST API list endpoint. For example:

curl -X OPTIONS \
-H "Authorization: Token $TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json; indent=4" \
http://netbox/api/dcim/devices/

(Note that all REST API endpoints are affected, not just the one above.)

Expected Behavior

The response should return metadata for the endpoint. An example is below.

{
    "name": "Device",
    "description": "",
    "renders": [
        "application/json",
        "text/html"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "POST": {
...

Observed Behavior

An exception is raised:

Exception Type: AssertionError at /api/dcim/devices/
Exception Value: Expected view DeviceViewSet to be called with a URL keyword argument named "pk". Fix your URL conf, or set the `.lookup_field` attribute on the view correctly.

It appears that the introduction of bulk update support poses a problem when rendering metadata for the endpoint, since the metadata class calls get_object() when evaluating fields for POST and PUT requests.

Originally created by @jeremystretch on GitHub (Dec 16, 2020). Originally assigned to: @jeremystretch on GitHub. ### Environment * Python version: 3.6.9 * NetBox version: 2.10.0 ### Steps to Reproduce 1. Make an `OPTIONS` request to a REST API list endpoint. For example: ``` curl -X OPTIONS \ -H "Authorization: Token $TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json; indent=4" \ http://netbox/api/dcim/devices/ ``` (Note that all REST API endpoints are affected, not just the one above.) ### Expected Behavior The response should return metadata for the endpoint. An example is below. ``` { "name": "Device", "description": "", "renders": [ "application/json", "text/html" ], "parses": [ "application/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "actions": { "POST": { ... ``` ### Observed Behavior An exception is raised: ``` Exception Type: AssertionError at /api/dcim/devices/ Exception Value: Expected view DeviceViewSet to be called with a URL keyword argument named "pk". Fix your URL conf, or set the `.lookup_field` attribute on the view correctly. ``` It appears that the introduction of bulk update support poses a problem when rendering metadata for the endpoint, since the metadata class calls `get_object()` when evaluating fields for `POST` and `PUT` requests.

adam added the type: bug status: accepted labels 2025-12-29 18:35:14 +01:00

adam closed this issue

2025-12-29 18:35:14 +01:00

adam referenced this issue

2025-12-29 22:23:49 +01:00

[PR #4364] [CLOSED] Add custom links to interface model #12824

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