Add a stable script identifier to Extras Scripts API #727

New Issue

MrUnknownDE · 2026-04-05T17:18:57+02:00

MrUnknownDE commented

2026-04-05 17:18:57 +02:00

Originally created by @pergus on 12/16/2025

NetBox version

v4.4.8

Feature type

Other

Proposed functionality

When listing scripts via the Extras Scripts API (/api/extras/scripts/), there isn’t a field that shows the fully qualified script name, like demo.Echo.

The API currently gives you id, name, and display, but none of these make it easy to identify a script:

id works for execution but isn’t predictable or portable
name isn’t unique — multiple scripts can have the same class name
display is meant for humans, not automation

This makes it tricky to figure out which script in the API corresponds to a specific script in code.

Proposed change

Add a read-only field called script_name that contains the module and class name, e.g.:

"script_name": "demo.Echo"

Where:

demo is the script module (the file name without .py)
Echo is the script class name

Example

Current output:

{
    "id": 68,
    "url": "http://localhost:8000/api/extras/scripts/68/",
    "display_url": "http://localhost:8000/extras/scripts/68/",
    "module": 118,
    "name": "Echo",
    "description": "Echo back any json sent to it",
    "vars": {},
    "result": null,
    "display": "Echo (demo)",
    "is_executable": true
}

Proposed output:

{
    "id": 68,
    "url": "http://localhost:8000/api/extras/scripts/68/",
    "display_url": "http://localhost:8000/extras/scripts/68/",
    "module": 118,
    "name": "Echo",
    "script_name": "demo.Echo",
    "description": "Echo back any json sent to it",
    "vars": {},
    "result": null,
    "display": "Echo (demo)",
    "is_executable": true
}

Use case

Why this helps

Gives a stable, human-readable identifier for scripts
Avoids confusion when multiple scripts have the same class name
Makes it easier to reference custom scripts from external scripts.

Database changes

No response

External dependencies

No response

*Originally created by @pergus on 12/16/2025* ### NetBox version v4.4.8 ### Feature type Other ### Proposed functionality When listing scripts via the Extras Scripts API (`/api/extras/scripts/`), there isn’t a field that shows the fully qualified script name, like `demo.Echo`. The API currently gives you `id`, `name`, and `display`, but none of these make it easy to identify a script: * `id` works for execution but isn’t predictable or portable * `name` isn’t unique — multiple scripts can have the same class name * `display` is meant for humans, not automation This makes it tricky to figure out which script in the API corresponds to a specific script in code. ### Proposed change Add a read-only field called `script_name` that contains the module and class name, e.g.: ```json "script_name": "demo.Echo" ``` Where: * `demo` is the script module (the file name without `.py`) * `Echo` is the script class name ### Example Current output: ```json { "id": 68, "url": "http://localhost:8000/api/extras/scripts/68/", "display_url": "http://localhost:8000/extras/scripts/68/", "module": 118, "name": "Echo", "description": "Echo back any json sent to it", "vars": {}, "result": null, "display": "Echo (demo)", "is_executable": true } ``` Proposed output: ```json { "id": 68, "url": "http://localhost:8000/api/extras/scripts/68/", "display_url": "http://localhost:8000/extras/scripts/68/", "module": 118, "name": "Echo", "script_name": "demo.Echo", "description": "Echo back any json sent to it", "vars": {}, "result": null, "display": "Echo (demo)", "is_executable": true } ``` ### Use case ## Why this helps * Gives a stable, human-readable identifier for scripts * Avoids confusion when multiple scripts have the same class name * Makes it easier to reference custom scripts from external scripts. ### Database changes _No response_ ### External dependencies _No response_

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox pending closure pending closure pending closure pending closure pending closure pending closure pending closure pending closure pending closure pending closure pending closure pending closure pending closure status: under review status: under review status: under review status: under review status: under review status: under review topic: custom scripts topic: custom scripts topic: custom scripts topic: custom scripts topic: custom scripts topic: custom scripts type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#727