Documentation | Support

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Introduction
Introduction
Management API Guide | Forcepoint Web Security | v8.5.x
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
See Management API object types for more information about the objects (categories, URLs, and IP addresses) that can be managed via the API.
API-managed categories:
*
Appear in category lists in the Forcepoint Security Manager, marked with the tag (restricted)
*
The "(restricted)" tag indicates that URLs and IP addresses within the category are managed exclusively through the API.
*
Administrators cannot use the Security Manager to add recategorized URLs or keywords to API-managed categories.
*
Are automatically assigned to the risk class Security Risk
*
Can be assigned actions (block, permit, and so on) in category filters
*
Appear in reports, alerts, and SIEM logs
*
Are not used by the hybrid service
Users whose traffic is sometimes managed by on-premises components and sometimes managed by the hybrid service may therefore see differences in policy enforcement, depending on whether they are inside or outside of your network.
If you have not yet deployed the Management API, see the Management API Deployment & Installation Guide for instructions.
To start using the Management API, see:
*
Management API overview for an introduction to API transactions and client/server interaction.
*
Management API object types for an overview of the object types that the API can manipulate.
*
Interfaces for information about the methods supported by the API.
*
v8.5.xApiParameters.ini for information about configuring API behavior.

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Introduction
Copyright 2022 Forcepoint. All rights reserved.