Introduction

The Management API for Forcepoint Web Security is a REST interface using JSON. It allows administrators to:

  • Create custom, API-managed categories
  • Add URLs and IP addresses to API-managed categories
  • Remove URLs and IP addresses from API-managed categories
  • Delete API-managed categories
  • View categories, URLs, IP addresses, and API status

API-managed categories appear in category filters in the Forcepoint Security Manager for both Super Administrators and delegated administrators. These categories are added to the Security Risk class and blocked by default. This means that as new threats are discovered by third-parties, they can quickly be added via the Management API and blocked for all users.

The Management API is not installed via the Forcepoint Web Security installer. Instead, administrators use a manual process to install and activate API components.

For deployment planning information and installation instructions, see:

  • Preparing to deploy the Management API
  • Installing the Management API on a Linux server

After you have completed the installation process, find instructions for using the API in the Management API Guide.

Note:

The Management API, which runs on port 15873, is separate from the Appliance API, which runs on port 443. The Appliance API is used for configuring and monitoring the appliance itself. For detailed instructions on its usage, see the Forcepoint Appliance REST API Documentation.

The Management API does not support TLSv1.2 by default. To enable TLSv1.2, a hotfix is required (For more details, see this article).