HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. bypass

Toggle bypass mode for NX appliances asynchronously

post
http://127.0.0.1:8080/bypass

Enables or disables bypass mode on NX hardware appliances. Only appliances supporting bypass (supportsBypass=true) are affected. Non-existent appliances are skipped. Returns a client key for polling operation status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON payload with bypass enable flag and list of appliance primary keys.

Request payload for async bypass toggle operation on NX appliances.

boolean
required

True to enable bypass mode, false to disable. Required field.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 13 hours ago

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

Updated about 13 hours ago

Did this page help you?