Forcepoint Management Center 2.0.0
App Vendor: Forcepoint
App Category: Network Security
Connector Version: 2.0.0
API Version: 8.5.x
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 Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Add API-Managed Category | This action adds API-managed categories. |
Add URL and IP to Category | This action adds URLs and IPs to the specified API-managed category. |
Commit Session | This action commits the changes done in a transaction. This can be done to add and delete categories, URLs, and IP addresses. |
Delete API-Managed Category | This action deletes the specified API-managed categories. |
Delete URL and IP From Category | This action deletes URLs and IPs from the defined API-managed category. |
Get System and Transaction Status | This action retrieves the status of system. |
List API-Managed Categories | This action lists all the API-managed categories. |
List All Categories | This action lists the custom categories created in Forcepoint Management Center and the API-managed categories. |
List URL and IP in Category | This action lists IPs and URLs present in an API-managed category. |
Roll Back Changes | This action cancels the changes made in a transaction, allowing you to roll back additions and deletions of categories, URLs, and IP addresses. |
Start Transaction | This action starts a session for adding and deleting categories, URLs, and IP addresses. |
Generic Action | This is a generic action used to make requests to any Forcepoint Management Center endpoint. |
Configuration Parameters
The following configuration parameters are required for the Forcepoint Management Center app to communicate with the Forcepoint Management Center enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to access Forcepoint Management Center. | Text | Required | |
Username | Enter the username to authenticate with Forcepoint Management Center. Example: John | Text | Required | |
Password | Enter the password to authenticate with Forcepoint Management Center. | Password | Required | |
Verify | Choose your preference to verify SSL verification while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. | Boolean | Optional | |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Forcepoint Management Center. | Integer | Optional | Allowed range: 15-120 Default value: 15 |
Action: Add API-Managed Category
This action adds API-managed categories. To view the newly added categories, you must commit the changes using the Commit Session action.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Categories | Enter the category details, including the name, description, and parent category ID. The category name is required and must be unique. Example: $LIST[$JSON[{"category name": "Malicious","category description" : "Represents harmful threats like malware.","parent": 0}]] | List | Required | 0 is the top-level category, and can be specified as the parent. You can only add subcategories to top-level categories |
Transaction ID | Enter the transaction ID to add category. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Required | You can retrieve this using the action Start Transaction. |
Action: Add URL and IP to Category
This action adds URLs and IPs to the specified API-managed category. To view the added URLs and IPs, you must commit the changes using the Commit Session action.
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: $LIST[Malicious IPs] | Text | Optional | You can retrieve this using the action List API-Managed Categories. |
IP Addresses | Enter the list of IPs to add to the category. Example: $LIST[1.1.1.1] | List | Optional | This is optional if a value is specified for the URLs parameter. |
URLs | Enter the list of URLs to add to the category. Example: $LIST[www.sampledomain.com] | List | Optional | This is optional if a value is specified for the IP Addresses parameter. |
Category ID | Enter the ID of the category to which you want to add IP addresses and URLs. Example: 1233 | Integer | Optional | You can retrieve this using the action List API-Managed Categories. |
Transaction ID | Enter the transaction ID to add URLs and IPs to the category. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Required | You can retrieve this using the action Start Transaction. |
Action: Commit Session
This action commits the changes done in a transaction. This can be done to add and delete categories, URLs, and IP addresses. Committing a session also terminates the existing transaction session.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Transaction ID | Enter the transaction ID to record API-managed categories, URLs, and IP addresses and ranges. To check the status of the commit, use the Get System and Transaction Status action. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Required | You can retrieve this using the action Start Transaction. |
Action: Delete API-Managed Category
This action deletes the specified API-managed categories. To view the changes after deleting, you must commit the changes using the Commit Session action.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Category Name | Enter the name of the category that you want to delete. Example: $LIST[Malicious IPs] | List | Optional | You can retrieve this using the action List API-Managed Categories. |
Category ID | Enter the category ID that you want to delete. Example: $LIST[1987,2078] | List | Optional | You can retrieve this using the action List API-Managed Categories. |
Transaction ID | Enter the transaction ID to delete the category. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Required | You can retrieve this using the action Start Transaction. |
Action: Delete URL and IP From Category
This action deletes URLs and IPs from the defined API-managed category. If an item is not found, the process proceeds to the next item without interruption. The count of deleted items reflects those removed from the system, excluding skipped items. Items that belong to other categories will remain in those categories but will be counted as removed from the specified category. The total number of deletions may be higher if duplicates were removed. To view the changes after removing URLs and IPs, you must commit the changes using the Commit Session action.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Category Name | Enter the name of the category from which you want to delete IP addresses and URLs. Example: Malicious ABC | Text | Optional | You can retrieve this using the action List API-Managed Categories. |
IP Addresses | Enter the list of IP addresses to delete from the category. Example: $LIST[1.1.1.1] | List | Optional | |
URLs | Enter the list of URLs to delete from the category. Example: $LIST[www.sampledomain.com] | List | Optional | |
Category ID | Enter the ID of the category from which you want to delete IP addresses and URLs. Example: 1233 | Integer | Optional | You can retrieve this using the action List API-Managed Categories. |
Transaction ID | Enter the transaction ID to delete URLs and IPs from the category. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Required | You can retrieve this using the action Start Transaction. |
Action: Get System and Transaction Status
This action retrieves the status of the system, which includes the health of the system, the total number of URLs, IP addresses, and ranges in the system.
Action Input Parameters
No input parameters are required for this action.
Action: List All Categories
This action lists the custom categories created in the Forcepoint Management Center and the API-managed categories.
Action Input Parameters
No input parameters are required for this action.
Action: List API-Managed Categories
This action lists all the API-managed categories.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Transaction ID | Enter the transaction ID to retrieve uncommitted categories. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Optional | You can retrieve this using the action Start Transaction. |
Action: List URL and IP in Category
This action lists IPs and URLs present in an API-managed category.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Category Name | Enter the name of the category to retrieve the list of IP addresses and URLs present in it. Example: $LIST[Malicious IPs] | Text | Optional | You can retrieve this using the action List API-Managed Categories. |
Category ID | Enter the ID of the category to retrieve the list of IP addresses and URLs present in it. Example: 1233 | Integer | Optional | You can retrieve this using the action List API-Managed Categories. |
Action: Roll Back Changes
This action cancels the changes made in a transaction, allowing you to roll back additions and deletions of categories, URLs, and IP addresses. This also terminates an existing session. You cannot roll back after committing changes.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Transaction ID | Enter the transaction ID to cancel the changes. Example: 44081c08-453a-11e6-a9de-d99213c464e0 | Text | Required | You can retrieve this using the action Start Transaction. |
Action: Start Transaction
This action starts a session for adding and deleting categories, URLs, and IP addresses. The transaction session lasts for 10 minutes. To end a session, you must either commit the session or roll back changes using the Commit Session and Roll Back Changes actions respectively.
Action Input Parameters
No input parameters are required for this action.
Action: Generic Action
This is a generic action used to make requests to any Forcepoint Management Center endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed values: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request to. Example: api/web/v1/categories/status | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional | Allowed keys: payload_data, custom_output, download, filename, files, retry_wait, retry_count, response_type, include_headers |