Bypass API overview

The process of using the Bypass Settings API works as follows:
  1. An API token (api-key-string) must be created in the Forcepoint Web Security Cloud. Navigate to the Platform Services > Admin and click the Generate API Token button.
  2. The client calls the Token Management API Generate Bearer Access Token endpoint to generate a Bearer Access token using the api-key-string generated in step 1.
  3. The client makes a call to the Bypass Settings API to create, read, update or delete categories. Clients must include the bearer access token (generated in step 2) in the Authorization header of each request.
  4. When the client executes a write operation (create, delete or update), a transaction ID will be returned.
  5. The client can call the Custom Categories Get Transaction status endpoint to get the status of the transaction that was created in step 4.

To prevent data collisions, the SSL Bypass API processes transactions in the order that they are executed.