Guide to enabling and using the Forcepoint FlexEdge Secure SD-WAN SMC 7.2.1 API, covering configuration, WebSockets, RESTful principles, and examples.
This guide explains how to enable and use the Forcepoint FlexEdge Secure SD-WAN SMC 7.2.1 API. The API lets external applications add, edit, and delete elements in the Management Server database, and the guide is intended for system administrators and developers.
It covers creating API Clients and TLS credentials, using WebSockets to monitor status information and browse log data, RESTful principles, entry point structure, data element formats, resource elements, specific searches, and examples. Detailed resource and action information is provided in smc_api.zip, with change logs in api_change_log.zip.
| Default API listening port | 8082 |
|---|---|
| Default HTTP session inactivity timeout | 30 minutes |
| Supported SMC API versions | 7.1 and 7.2.1 |
| Session identification methods | Cookies (default) and SSL Sessions |
In the Management Client, open the Management Server properties, click the SMC API tab, and select Enable.
The default listening port is 8082 on the Management Server.
By default it is 30 minutes; after that, the SMC API prompts you to log on again for new HTTP requests.
As a minimum, set the Viewer permission to All Simple Elements.