Documentation | Support

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Interfaces > Add API-managed categories
Add API-managed categories
Management API Guide | Forcepoint Web Security | v8.5.x
The POST command described in this section can be used to add categories as containers for URLs and IP addresses.
 
Method
URL
Description
POST
https://<ps_ip_address>:15873/api/web/v1/categories
Adds categories as described in a JSON request
JSON request data
The JSON request includes:
*
The transaction ID obtained in the start transaction call
*
The category name (required; must be unique)
An error is returned if the category name is not unique.
*
The category description (optional; blank by default)
*
The ID of the parent category
*
0 is the top-level category, and can be specified as the parent.
*
Categories can be added either to Forcepoint-defined (URL Database) categories or to API-managed categories. They cannot be added to custom categories created via the Forcepoint Security Manager.
*
Subcategories can be added to categories that have a parent of 0, but not to categories with a different parent.
For example:
{
"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
}
]
}
JSON response to add categories request
The JSON response includes the API-managed category names added to the transaction. For example:
{
"Categories":
[
{"Category Name":"Malicious XYZ",
{"Category Name":"Malicious ABC"
]
}
Response codes
 
200
OK (categories added successfully)
400
Bad JSON format or data
403
Authentication failed
409
Bad transaction ID or not in a transaction
500
Internal server error
JSON for bad request
{
"Error" :
[
"Bad JSON format.",
"Not in a transaction",
"Other Error Message"
]
}
 
* 
Note 
Category names and IDs are not checked until the data is committed to the system. Error messages for duplicate and missing categories (by name or ID) appear in the response to a status API call after the commit has finished.

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Interfaces > Add API-managed categories
Copyright 2022 Forcepoint. All rights reserved.