Script fails with KeyError when Optional Fields with defaults are missing from API payload #11762

New Issue

adam · 2025-12-29T21:49:35+01:00

adam commented

2025-12-29 21:49:35 +01:00

Originally created by @rizlas on GitHub (Oct 21, 2025).

Originally assigned to: @arthanson on GitHub.

NetBox Edition

NetBox Community

NetBox Version

v4.4.4

Python Version

3.10

Steps to Reproduce

Define a script in NetBox with fields like:

from extras.scripts import Script, BooleanVar, MultiObjectVar
from dcim.models import Device

class MyScript(Script):
    debug_mode = BooleanVar("Activate debug mode", default=False)

    def run(self, data, commit):
        debug = data["debug_mode"]  # Fails if not explicitly in payload
        return f"Debug mode: {debug}"

Run the script via:

curl -X POST \
-H "Authorization: Token TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json; indent=4" \
https://netbox/api/extras/scripts/MyScript/ \
--data '{
  "data": {},
  "schedule_at": "2025-10-28 10:15:00",
  "interval": 360,
  "commit": true
}'

Expected Behavior

The script should run successfully, applying default values to omitted fields: debug_mode should default to False

Observed Behavior

The script crashes with:

KeyError: 'debug_mode'
Traceback (most recent call last):
  File "/opt/netbox/netbox/extras/jobs.py", line 46, in run_script
    script.output = script.run(data, commit)
                    ^^^^^^^^^^^^^^^^^^^^^^^^
  File "<string>", line 145, in run
KeyError: 'debug_mode'

Originally created by @rizlas on GitHub (Oct 21, 2025). Originally assigned to: @arthanson on GitHub. ### NetBox Edition NetBox Community ### NetBox Version v4.4.4 ### Python Version 3.10 ### Steps to Reproduce Define a script in NetBox with fields like: from extras.scripts import Script, BooleanVar, MultiObjectVar from dcim.models import Device ```python class MyScript(Script): debug_mode = BooleanVar("Activate debug mode", default=False) def run(self, data, commit): debug = data["debug_mode"] # Fails if not explicitly in payload return f"Debug mode: {debug}" ``` Run the script via: ```bash curl -X POST \ -H "Authorization: Token TOKEN" \ -H "Content-Type: application/json" \ -H "Accept: application/json; indent=4" \ https://netbox/api/extras/scripts/MyScript/ \ --data '{ "data": {}, "schedule_at": "2025-10-28 10:15:00", "interval": 360, "commit": true }' ``` ### Expected Behavior The script should run successfully, applying default values to omitted fields: debug_mode should default to False ### Observed Behavior The script crashes with: ```python KeyError: 'debug_mode' Traceback (most recent call last): File "/opt/netbox/netbox/extras/jobs.py", line 46, in run_script script.output = script.run(data, commit) ^^^^^^^^^^^^^^^^^^^^^^^^ File "<string>", line 145, in run KeyError: 'debug_mode' ```

adam added the type: bug status: accepted netbox severity: low labels 2025-12-29 21:49:36 +01:00

adam closed this issue

2025-12-29 21:49:36 +01:00

adam commented

2025-12-29 21:49:36 +01:00

@arthanson commented on GitHub (Oct 29, 2025):

This is actually not a bug - the data is a mechanism to pass in data for the script to use for the script params - it is not the script parameters themselves. This same mechanism is used for event rules to pass data to scripts. If you want to get it this way you can use the get operator with a default: debug = data.get("debug_mode", False)

@arthanson commented on GitHub (Oct 29, 2025): This is actually not a bug - the data is a mechanism to pass in data for the script to use for the script params - it is not the script parameters themselves. This same mechanism is used for event rules to pass data to scripts. If you want to get it this way you can use the `get` operator with a default: `debug = data.get("debug_mode", 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#11762