NSM On-Prem: How to use API Gateway to export NSM settings and TSR

Description

Following steps show how to export NSM settings and TSR (Technical Support Report), using NSM included API Gateway.


Step 1: get the bearer token from NSM. Please refer the KB at the end of the article.

example token:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc1RGQSI6ZmFsc2UsImlzVEZBQ29tcGxldGVkIjpmYWxzZSwic2Vzc2lvbklEIjoiMjEyMzJmMjk3YTU3YTVhNzQzODk0YTBlNGE4MDFmYzMtMTEwMDI2Njc5NDUzOTM1MzU2MyIsImV4cCI6MTY4NDI5NjM4OX0.2i183irP6A37O-gIKJhf_LTEzta-QJP5d_4l6icRz6E


Step 2: log into NSM, click on the hyperlink to go to API Gateway:

Image


Step 3: click on "Authorize" to enter bearer token for authentication purpose. Find "Admin (apiKey)" section and paste bearer token there. Click on "Authorize" then "close":

Image


Step 4. find settings export section and click on "Try it out":

Image


Step 5. click "Execute":

Image


Step 6. Execute is successful. Now settings (example: nsm-settings_0040102A0210_2023-16-05_20-26-20.cfg) can be downloaded:

Image


Step 7. TSR can be downloaded as well. Need to enter "true" to include logs:

Image


KB on how to to get bearer token for API use:

https://www.sonicwall.com/support/knowledge-base/nsm-on-prem-how-to-get-bearer-token-for-api-use/230512164359940/


Related Articles

  • NSM On-Prem Reporting Server configuration
    Read More
  • How to upgrade NSM On-Prem firmware via console CLI (NSM On-Prem version 3.2.0 and above)
    Read More
  • Gen 7 NSM-Firewall Licensing Changes – Effective May 1, 2025
    Read More
not finding your answers?