Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Interfaces > Start a Management API transaction
Start a Management API transaction
Management API Guide | Forcepoint Web Security | v8.5.x
Use the POST command described in this section to start a session for adding and deleting categories, URLs, and IP addresses via the Management API. The start command must be run before any PUT, POST, or DELETE commands.
Only one Policy API Server in a global Forcepoint Web Security deployment can start a transaction at a time. If a transaction is in progress and administrators attempt to initiate a new transaction, a 409 error is returned.
 
After performing subsequent PUT, POST, or DELETE commands, run a commit command to commit the changes to the system (see Commit all categories, URLs, and IP addresses). If you do not want the transaction to be committed, use the rollback command to stop the transaction and discard all of the commands that are part of the transaction (see Roll back all category, URL, and IP address additions and deletions).
All subsequent requests after the transaction is started must include a transaction ID. If the ID is not included, a 400 (bad request) error is returned.
JSON response
The response includes the transaction ID, which can be used for issuing subsequent commands, including commit or rollback.
{
"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0"
}
Response codes
 

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Interfaces > Start a Management API transaction
Copyright 2022 Forcepoint. All rights reserved.