Swagger Definitions

The entire SentinelOS API is documented under the OpenAPI specification.

Download Specification

Download the OpenAPI file to import into Postman, Insomnia or generate SDK clients.

swagger.yaml

OpenAPI Definition

Download YAML

Interactive Viewer

API Structure

The API is divided into logical domains:

Network

  • /api/interfaces - Physical interfaces
  • /api/vlans - 802.1Q interfaces
  • /api/addresses - IP objects

Security

  • /api/policies - Security rules
  • /api/nat - Network translation
  • /api/zones - Security zones

System

  • /api/config/begin - Start Transaction
  • /api/config/commit - Apply Changes