---
title: Forcepoint Management
slug: connectors/forcepoint-management
docTags: 
createdAt: 2026-06-09T16:30:01.149Z
---

Forcepoint Management is a security platform that provides centralized control over web content filtering and network security.

Forcepoint Management is a comprehensive web security platform that enables organizations to manage and enforce security policies across URLs and IP addresses. This connector allows Swimlane Turbine users to seamlessly integrate with Forcepoint Management, providing capabilities to add, commit, and manage categories for enhanced policy enforcement. By leveraging this integration, users can automate the organization and categorization of web resources, ensuring efficient policy application and reporting, while also enabling rollback and transaction management for streamlined operations.

## Limitations

None to date.

## Supported Versions

This Forcepoint Management connector uses the Version 1 API.

## Additional Docs

- [API Documentation](https://help.forcepoint.com/websec/en-us/on-prem/85/mgmt_api_guide/A34F73C3-C213-4911-A924-A0110DEDA7E9.html)
- [Authentication](https://help.forcepoint.com/websec/en-us/on-prem/85/mgmt_api_guide/93CF59F5-58F3-496A-9341-4010EB657469.html)

## Configuration

## Prerequisites

Before you can use the Forcepoint Management connector for Turbine, you'll need access to the Forcepoint Management API. This requires the following:

- HTTP Basic authentication using the following parameters:
  - URL: The endpoint for accessing Forcepoint Management services.
  - Username: Your Forcepoint Management account username.
  - Password: The password associated with your Forcepoint Management account.

## HTTP Basic Authentication with the following parameters:

- URL: The endpoint URL for the Forcepoint Management API.
- Username: Your Forcepoint Management account username.
- Password: Your Forcepoint Management account password.

## Capabilities

This Connector provides the following capabilities:

- Add Categories
- Commit Transaction
- List All Categories
- List API Managed Categrories
- Rollback Transaction
- Start Transaction

### Add Categories

- Enables the addition of categories to organize URLs and IP addresses within Forcepoint Management.

### Commit Transaction

- Records API-managed categories, URLs, IP addresses, and ranges in Forcepoint Management for policy enforcement and reporting. The call is non-blocking.

### List All Categories

- Retrieve all categories, including Forcepoint-defined Master Database categories, available in the system.

### List API Managed Categrories

- Retrieves a list of all API-managed categories available in Forcepoint Management.

### Rollback Transaction

- Cancels all add and delete commands within a specified transaction in Forcepoint Management.

### Start Transaction

- Initiates a transaction in Forcepoint Management for managing categories, URLs, and IP addresses.

## Additional Documentation

- [Forcepoint Management Connector Documentation](https://docs.swimlane.com/connectors/forcepoint-management)
- [Forcepoint Management API Documentation](https://help.forcepoint.com/)

# Configurations

## HTTP Basic Authentication

Authenticates using username and password.

### Configuration Parameters

| **Parameter** | **Description**                    | **Type** | **Required** |
| ------------- | ---------------------------------- | -------- | ------------ |
| url           | A URL to the target host.          | string   | Required     |
| username      | Username                           | string   | Required     |
| password      | Password                           | string   | Required     |
| verify\_ssl   | Verify SSL certificate             | boolean  | Optional     |
| http\_proxy   | A proxy to route requests through. | string   | Optional     |

# Actions

## Add Categories

Enable the addition of categories to organize URLs and IP addresses within Forcepoint Management.

### Endpoint

- **URL:** `api/web/v1/categories`
- **Method:** `POST`

### Input

| **Argument Name**                 | **Type** | **Required** | **Description**                                                                                 |
| --------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------- |
| `Transaction ID`                  | string   | Optional     | The transaction ID obtained in the start transaction call.                                      |
| `Categories`                      | array    | Optional     | Parameter for Add Categories                                                                    |
| `Categories.Category Name`        | string   | Optional     | The category name. An error is returned if the category name is not unique.                     |
| `Categories.Category Description` | string   | Optional     | The category description.                                                                       |
| `Categories.Parent`               | number   | Optional     | The ID of the parent category. 0 is the top-level category, and can be specified as the parent. |

### Input Example

`{"json_body":{"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0","Categories":[{"Category Name":"Malicious XYZ","Category Description":"Categories found by XYZ engine","Parent":0},{"Category Name":"Malicious ABC","Category Description":"Categories found by ABC engine","Parent":128}]}}`

### Output

| **Parameter**              | **Type** | **Description**                  |
| -------------------------- | -------- | -------------------------------- |
| `status_code`              | number   | HTTP status code of the response |
| `reason`                   | string   | Response reason phrase           |
| `Categories`               | array    | Output field: Categories         |
| `Categories.Category Name` | string   | Name of the resource             |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Categories":[{},{}]}}`

## Commit Transaction

Record API-managed categories, URLs, IP addresses, and ranges in Forcepoint Management for policy enforcement and reporting. The call is non-blocking.

### Endpoint

- **URL:** `api/web/v1/categories/commit`
- **Method:** `POST`

### Input

| **Argument Name**          | **Type** | **Required** | **Description** |
| -------------------------- | -------- | ------------ | --------------- |
| `parameters.transactionid` | string   | Optional     | Transaction ID. |

### Input Example

`{"parameters":{"transactionid":"31341"},"json_body":{}}`

### Output

| **Parameter**    | **Type** | **Description**                  |
| ---------------- | -------- | -------------------------------- |
| `status_code`    | number   | HTTP status code of the response |
| `reason`         | string   | Response reason phrase           |
| `Transaction ID` | string   | Unique identifier                |
| `Commit Time`    | string   | Time value                       |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Transaction ID":"a468af86-453a-11e6-88af-a180af187bfd","Commit Time":"April 8, 2016 11:37 am"}}`

## List All Categories

Retrieve all categories, including Forcepoint-defined Master Database categories, available in the system.

### Endpoint

- **URL:** `api/web/v1/categories/all`
- **Method:** `GET`

### Output

| **Parameter**                              | **Type** | **Description**                                        |
| ------------------------------------------ | -------- | ------------------------------------------------------ |
| `status_code`                              | number   | HTTP status code of the response                       |
| `reason`                                   | string   | Response reason phrase                                 |
| `Categories`                               | array    | Output field: Categories                               |
| `Categories.Category Name`                 | string   | Name of the resource                                   |
| `Categories.Category ID`                   | number   | Unique identifier                                      |
| `Categories.Category Description`          | string   | Output field: Categories.Category Description          |
| `Categories.Category Hierarchy`            | number   | Output field: Categories.Category Hierarchy            |
| `Categories.Category Owner`                | string   | Output field: Categories.Category Owner                |
| `Categories.Children`                      | array    | Output field: Categories.Children                      |
| `Categories.Children.Category Name`        | string   | Name of the resource                                   |
| `Categories.Children.Category ID`          | number   | Unique identifier                                      |
| `Categories.Children.Category Description` | string   | Output field: Categories.Children.Category Description |
| `Categories.Children.Category Hierarchy`   | number   | Output field: Categories.Children.Category Hierarchy   |
| `Categories.Children.Category Owner`       | string   | Output field: Categories.Children.Category Owner       |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Categories":[{},{}]}}`

## List API Managed Categrories

Retrieve a list of all API-managed categories available in Forcepoint Management.

### Endpoint

- **URL:** `api/web/v1/categories`
- **Method:** `GET`

### Input

| **Argument Name**          | **Type** | **Required** | **Description**                                                              |
| -------------------------- | -------- | ------------ | ---------------------------------------------------------------------------- |
| `parameters.transactionid` | string   | Optional     | Lists all categories, including categories that have not yet been committed. |

### Input Example

`{"parameters":{"transactionid":"44081c08-453a-11e6-a9de-d99213c464e0"}}`

### Output

| **Parameter**                              | **Type** | **Description**                                        |
| ------------------------------------------ | -------- | ------------------------------------------------------ |
| `status_code`                              | number   | HTTP status code of the response                       |
| `reason`                                   | string   | Response reason phrase                                 |
| `Categories`                               | array    | Output field: Categories                               |
| `Categories.Category Name`                 | string   | Name of the resource                                   |
| `Categories.Category ID`                   | number   | Unique identifier                                      |
| `Categories.Category Description`          | string   | Output field: Categories.Category Description          |
| `Categories.Category Hierarchy`            | number   | Output field: Categories.Category Hierarchy            |
| `Categories.Category Owner`                | string   | Output field: Categories.Category Owner                |
| `Categories.Children`                      | array    | Output field: Categories.Children                      |
| `Categories.Children.Category Name`        | string   | Name of the resource                                   |
| `Categories.Children.Category ID`          | number   | Unique identifier                                      |
| `Categories.Children.Category Description` | string   | Output field: Categories.Children.Category Description |
| `Categories.Children.Category Hierarchy`   | number   | Output field: Categories.Children.Category Hierarchy   |
| `Categories.Children.Category Owner`       | string   | Output field: Categories.Children.Category Owner       |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Categories":[{},{}]}}`

## Rollback Transaction

Cancel all add and delete commands within a specified transaction in Forcepoint Management.

### Endpoint

- **URL:** `api/web/v1/categories/rollback`
- **Method:** `GET`

### Input

| **Argument Name**          | **Type** | **Required** | **Description** |
| -------------------------- | -------- | ------------ | --------------- |
| `parameters.transactionid` | string   | Optional     | Transaction ID. |

### Input Example

`{"parameters":{"transactionid":"31341"}}`

### Output

| **Parameter**    | **Type** | **Description**                  |
| ---------------- | -------- | -------------------------------- |
| `status_code`    | number   | HTTP status code of the response |
| `reason`         | string   | Response reason phrase           |
| `Transaction ID` | string   | Unique identifier                |
| `Rollback Time`  | string   | Time value                       |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Transaction ID":"a468af86-453a-11e6-88af-a180af187bfd","Rollback Time":"April 8, 2016 11:37 am"}}`

## Start Transaction

Initiates a transaction in Forcepoint Management for managing categories, URLs, and IP addresses.

### Endpoint

- **URL:** `api/web/v1/categories/start`
- **Method:** `POST`

### Output

| **Parameter**    | **Type** | **Description**                  |
| ---------------- | -------- | -------------------------------- |
| `status_code`    | number   | HTTP status code of the response |
| `reason`         | string   | Response reason phrase           |
| `Transaction ID` | string   | Unique identifier                |

### Output Example

`{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0"}}`

# Response Headers

| **Header**   | **Description**                                       | **Example**                   |
| ------------ | ----------------------------------------------------- | ----------------------------- |
| Content-Type | The media type of the resource                        | application/json              |
| Date         | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |
