Forcepoint NGFW SMC 7.0 API User Guide for Forcepoint Next Generation Firewall

Home
NGFW SMC API
Working with resource elements
You can manage resource elements with several operations.

NGFW SMC API
- Introduction
  Forcepoint NGFW Security Management Center (SMC) is part of the Forcepoint Next Generation Firewall (Forcepoint NGFW) 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.
  - Searching for resources
    You can filter each element entry point based on a specified part of a name, comment, or IP address.
  - Retrieving a resource
    You can use a GET request on the specific API Client element's URI to retrieve the content of the element.
  - Creating a resource
    To create an element, you need the associated element entry-point to execute a POST on it.
  - Updating a resource
    When updating an element, the REST operation is a PUT.
  - Deleting a resource
    When you want to delete an element, the REST operation is a DELETE.
- 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.

Working with resource elements

You can manage resource elements with several operations.

Searching for resources
You can filter each element entry point based on a specified part of a name, comment, or IP address.
Retrieving a resource
You can use a GET request on the specific API Client element's URI to retrieve the content of the element.
Creating a resource
To create an element, you need the associated element entry-point to execute a POST on it.
Updating a resource
When updating an element, the REST operation is a PUT.
Deleting a resource
When you want to delete an element, the REST operation is a DELETE.