HomeGuidesAPI Reference
API Reference

Set BIO Breakout state for a service provider

Updates the BIO (Business Intent Overlay) Breakout state for a service provider. When enabled (bioBreakout=1), the service provider is added to BIO Breakout Internet Policies and the service icon is saved to local storage. When disabled (bioBreakout=0), the service provider is removed from BIO policies and the icon path is cleared (except for Netskope). This operation updates the serviceorchestrationproviders table, modifies BIO policy configuration, and triggers orchestration progress updates for all appliances. A system action log entry is created to record the configuration change.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length ≥ 1
^[0-9]+$

Unique identifier of the service provider. Must be a valid numeric ID referencing an existing service provider in the serviceorchestrationproviders table.

Body Params

Request body containing the desired BIO Breakout state. Only the bioBreakout field is read from the ServiceOrchServiceProviderEntry object.

Request body for updating BIO Breakout state. Uses ServiceOrchServiceProviderEntry internally but only bioBreakout field is required.

integer
enum
required

Desired BIO Breakout state: 1 = enable (add service provider to BIO Breakout Internet Policies), 0 = disable (remove from policies).

Allowed:
Responses
204

Successfully updated the BIO Breakout state for the service provider. The database is updated, BIO policy is modified, service icon is saved to local storage (if enabled), and orchestration progress is triggered for all appliances. A system action log entry is created recording the change.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json