Error calling Script with schedule_at specified via API

[sawan]

Deployment Type

Self-hosted

NetBox Version

4.3.1

Python Version

3.12

Steps to Reproduce

Given the following simple Script:

from extras.scripts import Script
from extras.scripts import StringVar

class TestScript(Script):
    class Meta:
        scheduling_enabled = True

    some_message = StringVar(
        description="Print this message", min_length=10, max_length=100
    )

    def run(self, data, commit):
        self.log_info(f"The test worked, message is: {data.get('some_message')}")

Call using the API:

curl -X POST \
-H "Authorization: Token $NETBOX_TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json; indent=4" \
-d '{
      "data": {
        "some_message": "somevalue"
      },
      "commit": true,
      "schedule_at": "2025-05-21T09:25"
    }' \
"$NETBOX_URL/api/extras/scripts/test_script.TestScript/"

Expected Behavior

Script should execute normally — and it does if schedule_at is left out.

Specifying schedule_at via the UI works fine.

Observed Behavior

Exception Type: AttributeError at /api/extras/scripts/test_script.TestScript/

Traceback (most recent call last):
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
               ^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/django/views/decorators/csrf.py", line 65, in _view_wrapper
    return view_func(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/viewsets.py", line 124, in view
    return self.dispatch(request, *args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/views.py", line 509, in dispatch
    response = self.handle_exception(exc)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/views.py", line 469, in handle_exception
    self.raise_uncaught_exception(exc)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/views.py", line 480, in raise_uncaught_exception
    raise exc
    ^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/views.py", line 506, in dispatch
    response = handler(request, *args, **kwargs)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/extras/api/views.py", line 280, in post
    if input_serializer.is_valid():
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/serializers.py", line 223, in is_valid
    self._validated_data = self.run_validation(self.initial_data)
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/serializers.py", line 442, in run_validation
    value = self.to_internal_value(data)
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.12/site-packages/rest_framework/serializers.py", line 501, in to_internal_value
    validated_value = validate_method(validated_value)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/netbox/extras/api/serializers_/scripts.py", line 69, in validate_schedule_at
    if value and not self.context['script'].scheduling_enabled:
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Exception Type: AttributeError at /api/extras/scripts/test_script.TestScript/
Exception Value: 'Script' object has no attribute 'scheduling_enabled'
Raised during: extras.api.views.ScriptViewSet

[bctiemann]

It seems that these validation methods:

netbox/netbox/extras/api/serializers_/scripts.py

Lines 68 to 76 in 4ca4884

	def validate_schedule_at(self, value):
	if value and not self.context['script'].scheduling_enabled:
	raise serializers.ValidationError(_("Scheduling is not enabled for this script."))
	return value
	def validate_interval(self, value):
	if value and not self.context['script'].scheduling_enabled:
	raise serializers.ValidationError(_("Scheduling is not enabled for this script."))
	return value

Are written as though self.context['script'] is an extras.scripts.Script instance (i.e. the class that the uploaded script would inherit from), rather than a Script model object (which is what it actually resolves to in the serializer data).

If schedule_at or interval are not specified in the payload, these validations are not run. But if they are included, the incorrect lookup is performed and the exception occurs.

To correct this the validators will need to look up the actual script code from the disk and introspect it for the value of Meta.scheduling_enabled.

[RedLine89]

Experiencing the same issue when trying to set existing script for execution on specific interval. Fails only via an API, so same behaviour.

Input payload:

{
  "commit": true,
  "data": {
    "clli": "RouterA"
  },
  "interval": 5
}

NetBox returns 500 with the same error. NetBox release: NetBox Community v4.2.6-Docker-3.2.0 (2025-03-21)