Forcepoint FlexEdge Secure SD-WAN SMC 7.1 API User Guide

Home
NGFW SMC API
Entry point structure
Each entry point contains an operation verb and other information to direct the user to a URI.
Verbs
Verbs represent keywords for specific element operations.

NGFW SMC API
- Introduction
  Forcepoint FlexEdge Secure SD-WAN Manager (SMC) is part of the Forcepoint FlexEdge Secure SD-WAN solution. You can access the SMC in two ways: through the Management Client or through the SMC application programming interface (API).
- Configure SMC API
  The Application Programming Interface (API) of SMC allows external applications to connect with the SMC.
- Using WebSockets with the SMC API
  You can use WebSockets with the SMC API to monitor status information and browse log data.
- Working with RESTful principles
  The SMC API is a RESTful API that includes these features.
- Entry point structure
  Each entry point contains an operation verb and other information to direct the user to a URI.
  - Verbs
    Verbs represent keywords for specific element operations.
    - Self verbs
      The self verb is included in each element and is based on REST philosophy. The self verb allows you to retrieve the API URI for the current element.
    - Installing a policy from a Policy element
      The upload verb is present on several Policy elements, such as fw_policy.
    - Uploading the engine configuration from an engine element
      The upload verb is present on each engine element, such as single_fw.
    - Refreshing the engine configuration from an engine element
      You can use the refresh verb to refresh the policy from engine elements.
  - API discovery
    To ease migration during major version upgrades, it is preferable to discover the API starting from an entry-point rather than to define all URIs.
  - Links
    GET 7.1/api allows the discovery of all available entry-points of the API.
- Data element formats
  You can retrieve elements from the API in both JSON and XML formats.
- Working with resource elements
  You can manage resource elements with several operations.
- Specific searches
  The API makes it possible to execute specific searches, such as unused elements or duplicate IP addresses.
- Examples
  As you begin working with the SMC API, see these examples as a reference.

Verbs

Verbs represent keywords for specific element operations.

Verbs are listed in the XML/JSON element description as a link entry.

Self verbs
The self verb is included in each element and is based on REST philosophy. The self verb allows you to retrieve the API URI for the current element.
Installing a policy from a Policy element
The upload verb is present on several Policy elements, such as fw_policy.
Uploading the engine configuration from an engine element
The upload verb is present on each engine element, such as single_fw.
Refreshing the engine configuration from an engine element
You can use the refresh verb to refresh the policy from engine elements.

Copyright © 2024 Forcepoint LLC