Forcepoint FlexEdge Secure SD-WAN SMC 7.1 API User Guide

Home
NGFW SMC API
Examples
As you begin working with the SMC API, see these examples as a reference.
Working with Policy elements
The SMC API can be used to modify, upload, and monitor the status of Policy elements.

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.
- 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.
  - Client access and logon
    These tasks give the client access to the SMC through the API.
  - Working with hosts
    Use the SMC API to find and configure hosts and Host elements.
  - Working with IP address lists
    Use the SMC API to import IP address lists.
  - Working with Policy elements
    The SMC API can be used to modify, upload, and monitor the status of Policy elements.
    - Modifying a rule in a policy
      You can modify a rule within an existing policy.
    - Uploading a policy and monitoring its status
      There are two ways of uploading or refreshing a policy — from the engine and from the policy.
  - Working with VPNs
    You can use the SMC API to configure gateways, certificates, VPN topology, and settings for VPNs.
  - Filtering searches by group type
    It is possible to filter searches by group type.
  - Retrieving routing/antispoofing information
    You can retrieve static or dynamic routing information from an engine.

Working with Policy elements

The SMC API can be used to modify, upload, and monitor the status of Policy elements.

Modifying a rule in a policy
You can modify a rule within an existing policy.
Uploading a policy and monitoring its status
There are two ways of uploading or refreshing a policy — from the engine and from the policy.

Copyright © 2024 Forcepoint LLC