Forcepoint Management Center 1.0.0
App Vendor: Forcepoint
App Category: Network Security
Connector Version: 1.0.0
API Version: 8.3.0
About App
The Forcepoint Management Center API enables the automation and management of security policies, including controlling access to IP addresses and URLs, categorizing web content, and enforcing filtering rules across the network.
The Forcepoint Management Center app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
---|---|
Add Categories | This action adds categories as containers for URLs and IP addresses. |
Add URLs and IP Addresses to a Category | This action adds URLs and IP addresses to the specified category. |
Delete Category By ID | This action deletes the specified category. |
Delete Category By Name | The action deletes the specified categories. |
Lists All API categories | This action retrieves a list of all API-managed categories. |
Lists All categories | This action retrieves a list of all categories including Forcepoint defined master database categories. |
Configuration Parameters
The following configuration parameters are required for the Forcepoint NGFW Security Management Center app to communicate with the Forcepoint NGFW Security Management Center enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Endpoint | Enter the hostname. Example: "https://<ip/domain>" | Text | Required | |
Port | Enter the port number. Example: "8082" | Text | Required | |
Username | Enter the username. Example: "admin" | Text | Required | |
Password | Enter the password. Example: password | Password | Required | |
Verify | Enter if you want to verify TLS credentials. Example: True | Boolean | Required | Allowed values:
|
Action: Add Categories
This action adds categories as containers for URLs and IP addresses.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Category Name | Enter the name of the category. The value must be unique. Example: "quarantine" | Text | Required | |
Category Description | Enter the category description. Example: "description" | Text | Optional | |
Category ID | Enter the required category ID. Example: "0" | Text | Optional | Default value: 0 0 is the top-level category and can be specified as the parent. |
Example Request
[ { "category_name": "quarantine", "category_description": "description", "category_id": "12345" } ]
Action: Add URLs and IP Addresses to a Category
This action adds URLs and IP addresses to the specified category.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Category Name | Enter the name of the category to which you want to add IP addresses and URLs. Example: "quarantine" | Text | Required | |
IP Address | Enter the IP addresses you want to add to the category. Enter values as an array. Example: ["167.34.15.117", "167.34.16.118-167.34.16.120"] | Text | Optional | This is optional if a value is provided against the URL parameter. |
URL | Enter the URLs you want to add to the category. Enter values as an array. Example: ["http://www.test1.com", "http://www.test2.com"] | Text | Optional | This is optional if a value is provided against the IP Address parameter. |
Example Request
[ { "category_name": "quarantine", "ips": [ "167.34.15.117", "167.34.16.118-167.34.16.120", "2045:1221:1231::1331", "24.56.8.0/23", "55AF:F451::/32" ], "urls": [ "http://www.test1.com/test1", "http://www.test1.com/test2", "http://www.test1.com/test3" ] } ]
Action: Delete Category By ID
This action deletes the specified categories.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Category ID | Enter the category ID that you want to delete. Separate multiple values using commas. Example: ["category_01", "category_02"] | List | Required |
Example Request
[ { "category_id": [ "category_01", "category_02" ] } ]
Action: Delete Category By Name
The action deletes the specified categories.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Category Name | Enter the category name that you want to delete. Enter values as an array. Example: ["category_name_01", "category_name_02"] | List | Required |
Example Request
[ { "category_name": [ "category_name_01", "category_name_02" ] } ]
Action: Lists all API categories
This action retrieves a list of all API-managed categories.
Action Input Parameters
This action does not require any input parameters.
Action: Lists All categories
This action retrieves a list of all categories including Forcepoint defined master database categories.
Action Input Parameters
This action does not require any input parameters.