About SonicOS 8

About the API and CLI

The SonicOS Enterprise Command Line Interface (E-CLI) provides a concise and powerful way to configure SonicWall security appliances without using the SonicOS 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 8 Command Line Interface Reference Guide on the SonicWall technical documentation portal.

The SonicOS RESTful API (Representational State Transfer Application Program Interface) provides an alternative method to the SonicOS 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 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.

SonicOS API page

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

The SonicOS API Swagger access page is displayed.

SonicOS Swagger access page

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

Top of sonicos_api.yml

Was This Article Helpful?

Help us to improve our support portal

Techdocs Article Helpful form

  • Hidden
  • Hidden

Techdocs Article NOT Helpful form

  • Still can't find what you're looking for? Try our knowledge base or ask our community for more help.
  • Hidden
  • Hidden