Add a stable script identifier to Extras Scripts API #11928

New Issue

adam · 2025-12-29T21:51:37+01:00

adam commented

2025-12-29 21:51:37 +01:00

Originally created by @pergus on GitHub (Dec 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 GitHub (Dec 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_

adam added the type: feature status: under review netbox labels 2025-12-29 21:51:37 +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#11928