• 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

How to Use the Swagger Interface

The RESTful APIs are a set of JSON objects that define their naming, order, and contents. By standardizing the API, each of its component can be displayed in a stylized, interactive framework. Within that framework, you can learn about a specific API and try it.

Before making any requests through API, generate the MSW API Key in MySonicWall. For more information, refer to Generating MSW API Key.

You need to generate the API key before you try any of the other operations. This tells you what the response looks like and how it is structured, so you can decide how to parse it. Preview what happens prior to finalizing.