List API-managed categories or all categories
The following GET command can be used to view a list of either:
- API-managed categories
- All categories (including custom categories created in the Forcepoint Security Manager and via the API)
This option is provided to give administrators a way to find the ID for Master Database or custom categories that will be used as a parent for one or more API- managed categories.
The Management API cannot use these IDs in any other way (for example, it is not possible to delete URLs from a Master Database category).
If a transaction ID is not provided, the category list is limited to the categories stored in the system. If a transaction ID is provided, any new categories in the pending transaction are included.
Method | URL | Description |
---|---|---|
GET | https:<ps_ip_address>:15873/api/ web/v1/categories/all | Lists all categories (including Forcepoint-defined Master Database categories) |
GET | https://<ps_ip_address>:15873/api/ web/v1/categories | Lists all API-managed categories |
GET | https://<ps_ip_address>:15873/api/ web/v1/ categories?transactionid=<txn_id> | Lists all categories, including categories that have not yet been committed |