HomeGuidesAPI Reference
API Reference

Get bypass mode settings for an appliance

Retrieves the bypass mode settings for a specific NX appliance. Bypass mode allows traffic to pass through the appliance without optimization when enabled. Use cached=true for faster responses or cached=false to query the appliance directly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string
enum
Defaults to true

When true, retrieves data from Orchestrator cache. When false, fetches fresh data directly from the appliance. Defaults to 'true' if not provided.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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