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

Update IDS/IPS mode for appliances

put
http://127.0.0.1:8080/ids/state

Updates the IDS/IPS operational mode for specified appliances. Each appliance can be assigned to one of four modes: disabled, IDS (detection only), IPS lookaside (passive), or IPS inline (active). The nePks array must contain the exact union of all mode arrays. Changes trigger automatic orchestration to apply configurations to affected appliances.

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

IDS/IPS mode assignments for appliances. Each appliance must appear in exactly one mode array, and the nePks field must equal the union of all mode arrays.

Request body for updating IDS/IPS mode assignments. The nePks field must equal the union of all mode arrays. An appliance can only be in one mode at a time.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
ids
array of strings
Defaults to []

Appliances to set to IDS (detection-only) mode. Traffic is monitored and alerts are generated but threats are not blocked.

ids
disabled
array of strings
Defaults to []

Appliances to disable IDS/IPS functionality. No intrusion detection or prevention is performed on these appliances.

disabled
ips_lookaside
array of strings
Defaults to []

Appliances to set to IPS lookaside (passive) mode. Traffic is analyzed out-of-band with minimal latency impact.

ips_lookaside
ips_inline
array of strings
Defaults to []

Appliances to set to IPS inline (active) mode. Traffic is inspected inline and malicious packets are dropped. Requires appliance version 9.4.1 or higher.

ips_inline
Responses

Updated about 14 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

Updated about 14 hours ago

Did this page help you?