• About SonicOS and SonicOSX 7
  • What is SonicOS/X 7?
  • Where Do I Find Information?
  • SonicOS Web Interface to Admin Guides Reference
  • SonicOSX Web Interface to Admin Guides Reference
  • Guide Conventions
• Firewall Management Methods
• About the SonicOS/X Management Interface
  • Logging into SonicOS/X
  • Logging Out of SonicOS/X
  • Contemporary vs Classic Web Interface
  • Global Search
  • Online Help
  • Notification Center
  • SonicOS/X Guides (Wizards)
  • SSH Terminal Access
  • About the Top Menu Views
  • About the API and CLI
  • Legal Information
• What's New in SonicOS/X 7.0.1
• Features in Both SonicOS and SonicOSX
• Features Specific to SonicOSX
  • About Unified Policies in SonicOSX
  • About the Shadow Feature
  • About Action Profiles
• Features Specific to TZ, NSa and NSsp 13700
  • Switch Management
  • PortShield Groups
  • Access Points Management
  • WWAN and 4G/LTE
  • Storage Device Configuration
• Features Specific to NSv
  • Feature Support on NSv Series
  • Changing Between SonicOS and SonicOSX
    • Choosing the Mode in Fresh Deployments or Upgrades
    • Changing From Classic to Policy Mode
    • Changing From Policy to Classic Mode
• Features Specific to NSsp 15700
  • About Multi-Instance
• SonicWall Support

About the API and CLI

The SonicOS/X Enterprise Command Line Interface (E-CLI) provides a concise and powerful way to configure SonicWall security appliances without using the SonicOS/X web management interface. You can use the CLI commands individually on the command line or in scripts for automating configuration tasks. You can access the CLI by connecting to the Console port via SSH or with a serial connection. For more information, refer to the SonicOS/X 7 Command Line Interface Reference Guide on the SonicWall technical documentation portal.

The SonicOS/X RESTful API (Representational State Transfer Application Program Interface) provides an alternative method to the SonicOS/X CLI for configuring the firewall. You can use the API to configure each and every feature on the firewall or to script configuration sequences.

For more information, see the SonicOS/X 7 API Reference Guide on the SonicWall technical documentation portal.

To access the API, navigate to HOME | API and click the link in the SONICWALL SONICOS API AGREEMENT section.

You can also enter the link directly into your browser, https://sonicos-api.sonicwall.com.

The SonicOS API Swagger access page is displayed.

Set up your authentication and log in for the complete API command list and syntax.