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 Response Rule API

Operations about Response Rule

NeuVector Response 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 Response 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 7 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

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

7 operations 3 paths 8 schemas 2 DELETE3 GET2 PATCH

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 Response 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 7

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

Response Rule 7

Operations about Response Rule

GET
/v1/response/rule
Get a list of response rules
1 param → 200
PATCH
/v1/response/rule
Update response rule action
1 param → 200
DELETE
/v1/response/rule
Delete all response rules
1 param → 200
GET
/v1/response/rule/{id}
Get a response rule
1 param → 200
PATCH
/v1/response/rule/{id}
Update a response rule
2 params → 200
DELETE
/v1/response/rule/{id}
Delete a response rule
1 param → 200
GET
/v1/response/workload_rules/{id}
Get response rule workload
1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are RESTResponseRule (9 properties), RESTResponseRuleConfig (9 properties), RESTCLUSEventCondition (2 properties), RESTResponseRuleInsert (2 properties). Each schema is shown below with its type and property counts.

RESTResponseRulesData
object
1 property 1 required
RESTResponseRuleData
object
1 property 1 required
RESTCLUSEventCondition
object
2 properties
RESTResponseRule
object
9 properties 9 required
RESTResponseRuleConfigData
object
1 property 1 required
RESTResponseRuleConfig
object
9 properties 2 required
RESTResponseRuleInsert
object
2 properties 1 required
RESTResponseRuleActionData
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-response-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