NeuVector

NeuVector Response Rule API

Operations about Response Rule

GitHub OpenAPI

Operations 7

GET /v1/response/rule Get a list of response rules
PATCH /v1/response/rule Update response rule action
DELETE /v1/response/rule Delete all response rules
GET /v1/response/rule/{id} Get a response rule
PATCH /v1/response/rule/{id} Update a response rule
DELETE /v1/response/rule/{id} Delete a response rule
GET /v1/response/workload_rules/{id} Get response rule workload

Documentation

📖
Documentation
https://open-docs.neuvector.com/
📖
GettingStarted
https://open-docs.neuvector.com/deploying
📖
APIReference
https://open-docs.neuvector.com/automation/automation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/neuvector/refs/heads/main/openapi/neuvector-response-rule-api-openapi.yml

Other Resources

🔗
Source OpenAPI
https://github.com/neuvector/neuvector/blob/main/controller/api/apis.yaml
🔗
Source Code
https://github.com/neuvector/neuvector

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/neuvector-response-rule-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

neuvector-response-rule-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Secure Docker and Kubernetes based container deployments with the NeuVector run-time security solution.
  version: 5.6.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: NeuVector Response Rule API
  contact:
    email: support@neuvector.com
servers:
- url: https://localhost:10443/
tags:
- name: Response Rule
  description: Operations about Response Rule
paths:
  /v1/response/rule:
    get:
      tags:
      - Response Rule
      summary: Get a list of response rules
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: query
        name: scope
        required: false
        description: When set to fed, returned fed response rules. When set to local, returned local response rules. If there is no query string 'scope', all response rules will be returned.
        schema:
          type: string
          enum:
          - fed
          - local
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTResponseRulesData'
    patch:
      tags:
      - Response Rule
      summary: Update response rule action
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTResponseRuleActionData'
        description: Response rule action data
        required: true
    delete:
      tags:
      - Response Rule
      summary: Delete all response rules
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: query
        name: scope
        required: false
        description: When set to fed, all fed response rules get removed. When set to local or no query string, local response rules will be removed.
        schema:
          type: string
          enum:
          - fed
          - local
      responses:
        '200':
          description: Success
  /v1/response/rule/{id}:
    get:
      tags:
      - Response Rule
      summary: Get a response rule
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Rule ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTResponseRuleData'
    patch:
      tags:
      - Response Rule
      summary: Update a response rule
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Rule ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTResponseRuleConfigData'
        description: Response rule data
        required: true
    delete:
      tags:
      - Response Rule
      summary: Delete a response rule
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Rule ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
  /v1/response/workload_rules/{id}:
    get:
      tags:
      - Response Rule
      summary: Get response rule workload
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Workload rules ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTResponseRulesData'
components:
  schemas:
    RESTResponseRuleData:
      type: object
      required:
      - rule
      properties:
        rule:
          $ref: '#/components/schemas/RESTResponseRule'
    RESTResponseRulesData:
      type: object
      required:
      - rules
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RESTResponseRule'
    RESTResponseRuleActionData:
      type: object
      properties:
        insert:
          $ref: '#/components/schemas/RESTResponseRuleInsert'
    RESTResponseRule:
      type: object
      required:
      - id
      - event
      - comment
      - group
      - conditions
      - actions
      - webhooks
      - disable
      - cfg_type
      properties:
        id:
          type: integer
          format: uint32
          example: 1001
        event:
          type: string
          example: ''
        comment:
          type: string
          example: ''
        group:
          type: string
          example: ''
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RESTCLUSEventCondition'
        actions:
          type: array
          items:
            type: string
            example: ''
        webhooks:
          type: array
          items:
            type: string
            example: ''
        disable:
          type: boolean
          example: false
        cfg_type:
          type: string
          enum:
          - user_created
          - ground
          - federal
    RESTResponseRuleInsert:
      type: object
      required:
      - rules
      properties:
        after:
          type: integer
          example: 0
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RESTResponseRule'
    RESTResponseRuleConfigData:
      type: object
      required:
      - config
      properties:
        config:
          $ref: '#/components/schemas/RESTResponseRuleConfig'
    RESTCLUSEventCondition:
      type: object
      properties:
        type:
          type: string
          example: ''
        value:
          type: string
          example: ''
    RESTResponseRuleConfig:
      type: object
      required:
      - id
      - cfg_type
      properties:
        id:
          type: integer
          format: uint32
          example: 1001
        comment:
          type: string
          example: ''
        group:
          type: string
          example: ''
        event:
          type: string
          example: ''
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RESTCLUSEventCondition'
        actions:
          type: array
          items:
            type: string
            example: ''
        webhooks:
          type: array
          items:
            type: string
            example: ''
        disable:
          type: boolean
          example: false
        cfg_type:
          type: string
          enum:
          - user_created
          - ground
          - federal
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Auth-Apikey
    TokenAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
externalDocs:
  description: Find out more about NeuVector
  url: https://www.suse.com/products/neuvector/