• API Overview
  • End User Product Agreement
  • Terminology
  • Description
  • Accessing the API Documentation
  • How to Use the Swagger Interface
  • Supported Request Methods
  • Generating MSW API Key
  • Generating NSM Token using MySonicWall API Key
  • Generating Capture Client Token using MySonicWall API Key
• Sample API Functions
  • Provisioning a Tenant
    • Request Parameters
    • Response Class Example Value
  • Provisioning a New Product or Editing an Existing Product
    • Request Parameters
    • Response Class Example Value
  • Inviting a New User
    • Request Parameters
    • Response Class Example Value
• MySonicWall API Support
  • About This Document

Generating MSW API Key

All MySonicWall users can generate API key to use in the Swagger or any other API platform. Most MSW APIs support monthly billing work flows at this time but other users can utilize MSW API key to generate NSM token and access NSM APIs.

To generate MSW API key

1. Login to https://www.mysonicwall.com/.
2. Navigate to Monthly Billing | Access Management > Users or My Workspace | User Groups > User list.
3. Click Generate My API Key on top of the table.

4. Enter Description, Source IP Address (optional) for the MSW API Key.

   By the default, Validity of the key is set for 1 year. Maximum duration of the API key is 1 year. However, you can set the custom validity of any duration under 1 year, if required.

5. Click Confirm.

6. Click the Copy to clipboard icon to copy the API Key.

   

   You cannot view or copy the API key once you close the GENERATE API KEY pop-up window. Make sure that the API key is copied and saved to use in the Swagger or any other API platform.

7. Click Close.

• Admin of the account can view the API keys generated for the users. If required, admin can revoke the API Key.
• Your API access is determined based on the access levels in MySonicWall.