Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NeuVector WAF Rule API

Operations about waf Rule

NeuVector WAF Rule API is one of 31 APIs that NeuVector publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WAF Rule. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 10 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

Requests are made against the base URL https://localhost:10443.

10 operations 6 paths 21 schemas 1 DELETE6 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
5.6.0
Base URL
https://localhost:10443
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

NeuVector WAF Rule API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Apikey (ApiKeyAuth). An API key is passed in the header as X-Auth-Token (TokenAuth).

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

WAF Rule 10

Operations about waf Rule

GET
/v1/waf/sensor
Get waf rule list
1 param → 200
POST
/v1/waf/sensor
Create waf sensor
1 param → 200
GET
/v1/waf/sensor/{name}
Get waf sensor detail
1 param → 200
PATCH
/v1/waf/sensor/{name}
Update a waf sensor
2 params → 200
DELETE
/v1/waf/sensor/{name}
Delete a waf sensor
1 param → 200
GET
/v1/waf/group
Get waf group list
1 param → 200
GET
/v1/waf/group/{name}
Get waf group detail
1 param → 200
PATCH
/v1/waf/group/{name}
Update a waf group
2 params → 200
GET
/v1/waf/rule
Get waf rule list
→ 200
GET
/v1/waf/rule/{name}
Get waf rule detail
1 param → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RESTWafSensor (6 properties), RESTDlpSensorConfig (5 properties), RESTWafSetting (5 properties), RESTWafSensorConfig (5 properties). Each schema is shown below with its type and property counts.

RESTWafSensorData
object
1 property 1 required
RESTWafGroup
object
4 properties 4 required
RESTWafSensorConfigData
object
1 property 1 required
RESTDlpRule
object
4 properties 4 required
RESTCriteriaEntry
object
3 properties 3 required
RESTWafGroupConfig
object
5 properties 1 required
RESTWafGroupData
object
1 property 1 required
RESTWafRuleDetail
object
2 properties 2 required
RESTWafSensorsData
object
1 property 1 required
RESTWafRule
object
4 properties 4 required
RESTDlpSensorConfig
object
5 properties 1 required
RESTDlpSensorConfigData
object
1 property 1 required
RESTWafSensor
object
6 properties 6 required
RESTWafSetting
object
5 properties 4 required
RESTWafRulesData
object
1 property 1 required
RESTWafCriteriaEntry
object
4 properties 3 required
RESTWafConfig
object
3 properties 2 required
RESTWafGroupConfigData
object
1 property 1 required
RESTWafRuleData
object
1 property 1 required
RESTWafSensorConfig
object
5 properties 1 required
RESTWafGroupsData
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-waf-rule-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
NeuVector Apikey API
NeuVector Authentication API
NeuVector Compliance API
NeuVector compliance profile. The payload body is the content of the compliance profile yaml file. API
NeuVector compliance profile. The payload body is the content of the vulnerability profile yaml file. API
NeuVector Container API
NeuVector Controller API
NeuVector DLP API
NeuVector Enforcer API
NeuVector EULA API
NeuVector Federation API