The OpenAPI server provides RESTful API access to switch configuration and operational state, enabling integration with third-party automation and management tools such as Ansible. This chapter describes how to enable, configure, and manage the OpenAPI server on Universal Platforms.
The OpenAPI server operates alongside other web-based interfaces (Chalet, RESTCONF) and is accessible via standard HTTP/HTTPS ports using URI-based path multiplexing. When IQAgent is enabled, the OpenAPI server operates automatically to support cloud management. Users can also enable the server independently for integration with custom automation tools.
For information about using the REST API itself, including available endpoints, request formats, and response structures, refer to the OpenAPI schema documentation available at https://<switch-ip>/rest/openapi after enabling the server.
Note
The OpenAPI server management commands are available on Universal Platforms. Debug commands are available on all platforms. For specific information regarding platform support, see the platform-specific documentation.