NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-23 16:06:43 -06:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

13815 document view permissions for scripts

Browse Source
This commit is contained in:
Arthur 2023-10-02 09:03:00 -07:00
parent 786f0cc7f3
commit 5f207bee01
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/customization/custom-scripts.md
View File

@ -296,6 +296,9 @@ An IPv4 or IPv6 network with a mask. Returns a `netaddr.IPNetwork` object. Two a
Custom scripts can be run via the web UI by navigating to the script, completing any required form data, and clicking the "run script" button. It is possible to schedule a script to be executed at specified time in the future. A scheduled script can be canceled by deleting the associated job result object.
!!! note
To be able to view and run a custom script, a user must have the following view permissions: `Extras > Script`, `Extras > ScriptModule`, `Core > ManagedFile`. As well as be assigned the extras.run_script permission as shown above.
### Via the API
To run a script via the REST API, issue a POST request to the script's endpoint specifying the form data and commitment. For example, to run a script named `example.MyReport`, we would make a request such as the following: