MySonicWall API Reference Guide

Description

APIs are the most common way for different companies and products to integrate with each other as a part of a business ecosystem. REST is an architectural style used for creating web services within this ecosystem. REST-compliant, or RESTful, web services allow the requesting systems to access and manipulate web resources, through an API, by using a uniform and predefined set of stateless operations. This allows a programmer to access exposed objects or actions within the system so things can be customized.

The server does not maintain a state because RESTful APIs are stateless. The client maintains the state. The server can provide a state to the client via a token. The client then maintains and returns the token when accessing the server. Since the state is in the token given to the client—even if the server goes down or the client contacts another server in a cluster—the client can still interact properly with the server.

The API uses HTTP and HTTPS requests to GET, PUT, POST or DELETE data. This API reference guide documents the individual calls but also allows you to try out the individual calls and get sample cURL calls that can be dropped into shell scripts.

TheMySonicWall team uses Swagger (also known as the Open API Initiative) to provide the API documentation. It’s built into the code and renders it in a clean and clear way. It also provides an interactive test tool when you customize an operation. The output is provided in JSON format.

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