NeuVector Policy API

Operations about Policy

Operations 7

GET /v1/policy/rule Get a list of policy rules
PATCH /v1/policy/rule Policy rule action
DELETE /v1/policy/rule Delete all policy rules
GET /v1/policy/rule/{id} Show policy rule
PATCH /v1/policy/rule/{id} Update policy rule
DELETE /v1/policy/rule/{id} Delete policy rule
POST /v1/policy/rules/promote Promote policy

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-policy-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.

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

OpenAPI Specification

neuvector-policy-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 Policy API
  contact:
    email: support@neuvector.com
servers:
- url: https://localhost:10443/
tags:
- name: Policy
  description: Operations about Policy
paths:
  /v1/policy/rule:
    get:
      tags:
      - Policy
      summary: Get a list of policy rules
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: query
        name: scope
        required: false
        description: When set to fed, returned fed policy rules. When set to local, returned local policy rules. If there is no query string 'scope', all policy rules will be returned.
        schema:
          type: string
          enum:
          - fed
          - local
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTPolicyRulesData'
    patch:
      tags:
      - Policy
      summary: Policy rule action
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: query
        name: scope
        required: false
        description: When set to fed, fed policy rules get created. When set to local or no query string, local policy rules get created.
        schema:
          type: string
          enum:
          - fed
          - local
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTPolicyRuleActionData'
        description: Policy rule action data
        required: true
    delete:
      tags:
      - Policy
      summary: Delete all policy rules
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: query
        name: scope
        required: false
        description: When set to fed, fed policy rules get removed. When set to local or no query string, local policy rules get removed.
        schema:
          type: string
          enum:
          - fed
          - local
      responses:
        '200':
          description: Success
  /v1/policy/rule/{id}:
    get:
      tags:
      - Policy
      summary: Show policy rule
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Rule ID
        required: true
        schema:
          type: integer
          format: uint32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTPolicyRuleData'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTError'
    patch:
      tags:
      - Policy
      summary: Update policy rule
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Rule ID
        required: true
        schema:
          type: integer
          format: uint32
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTPolicyRuleConfigData'
        description: Policy rule update data
        required: true
    delete:
      tags:
      - Policy
      summary: Delete policy rule
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Rule ID
        required: true
        schema:
          type: integer
          format: uint32
      responses:
        '200':
          description: Success
  /v1/policy/rules/promote:
    post:
      tags:
      - Policy
      summary: Promote policy
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTPolicyPromoteRequestData'
        description: Policy promote data
        required: true
components:
  schemas:
    RESTPwdProfileBasic:
      type: object
      required:
      - min_len
      - min_uppercase_count
      - min_lowercase_count
      - min_digit_count
      - min_special_count
      properties:
        min_len:
          type: integer
          example: 6
        min_uppercase_count:
          type: integer
          example: 0
        min_lowercase_count:
          type: integer
          example: 0
        min_digit_count:
          type: integer
          example: 0
        min_special_count:
          type: integer
          example: 0
    RESTPolicyRuleMove:
      type: object
      required:
      - id
      properties:
        after:
          type: integer
          example: 0
        id:
          type: integer
          format: uint32
          example: 10005
    RESTError:
      type: object
      required:
      - code
      - error
      - message
      properties:
        code:
          type: integer
          example: 3
        error:
          type: string
          example: Request failed
        message:
          type: string
          example: Invalid format
        password_profile_basic:
          $ref: '#/components/schemas/RESTPwdProfileBasic'
        import_task_data:
          $ref: '#/components/schemas/RESTImportTaskData'
    RESTPolicyRulesData:
      type: object
      required:
      - rules
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RESTPolicyRule'
    RESTImportTask:
      type: object
      required:
      - tid
      - ctrler_id
      - percentage
      properties:
        tid:
          type: string
          example: c5af897b62a258212ece91c0551d3a4a
        ctrler_id:
          type: string
          example: 6e60452b244b90456f3450c9fed0a50f57f4b849dcb74a5fad289e8116f32f36
        last_update_time:
          type: string
          format: date-time
          example: '2022-03-17T17:31:55.832768041Z'
        percentage:
          type: integer
          example: 100
        triggered_by:
          type: string
          example: admin
        status:
          type: string
          example: done
        temp_token:
          type: string
          example: ''
        fail_to_decrypt_key_fields:
          type: object
          description: Object key is kv key and value is array of cloaked fields that cannot be decrypted
          additionalProperties:
            type: array
            items:
              type: string
            example:
            - x509_cert
            - signing_cert
    RESTImportTaskData:
      type: object
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/RESTImportTask'
    RESTPolicyPromoteRequest:
      type: object
      required:
      - ids
      properties:
        ids:
          type: array
          items:
            type: integer
            format: uint32
            example: 12
    RESTPolicyRuleConfig:
      type: object
      required:
      - id
      - cfg_type
      properties:
        id:
          type: integer
          format: uint32
          example: 10001
        comment:
          type: string
          example: a deny rule
        from:
          type: string
          example: nv.iperfclient
        to:
          type: string
          example: external
        ports:
          type: string
          example: any
        action:
          type: string
          example: deny
        applications:
          type: array
          items:
            type: string
          example:
          - HTTP
          - SSH
        disable:
          type: boolean
          example: true
        cfg_type:
          type: string
          enum:
          - learned
          - user_created
          - ground
          - federal
        priority:
          type: integer
          format: uint32
          example: 0
    RESTPolicyRuleActionData:
      type: object
      properties:
        move:
          $ref: '#/components/schemas/RESTPolicyRuleMove'
        insert:
          $ref: '#/components/schemas/RESTPolicyRuleInsert'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RESTPolicyRule'
        delete:
          type: array
          items:
            type: integer
            format: uint32
          example:
          - 1234
    RESTPolicyRuleInsert:
      type: object
      required:
      - rules
      properties:
        after:
          type: integer
          example: 0
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RESTPolicyRule'
    RESTPolicyRuleData:
      type: object
      required:
      - rule
      properties:
        rule:
          $ref: '#/components/schemas/RESTPolicyRule'
    RESTPolicyRule:
      type: object
      required:
      - id
      - comment
      - from
      - to
      - ports
      - action
      - applications
      - learned
      - disable
      - created_timestamp
      - last_modified_timestamp
      - cfg_type
      - priority
      - match_counter
      - last_match_timestamp
      properties:
        id:
          type: integer
          format: uint32
          example: 10002
        comment:
          type: string
          example: a rule
        from:
          type: string
          description: group name
          example: nv.iperfc
        to:
          type: string
          description: group name
          example: Host:10.2.127.3
        ports:
          type: string
          description: free-style port list
          example: any
        action:
          type: string
          example: allow
        applications:
          type: array
          items:
            type: string
            example: DNS
        learned:
          type: boolean
          example: true
        disable:
          type: boolean
          example: false
        created_timestamp:
          type: integer
          format: int64
          example: 1516563263
        last_modified_timestamp:
          type: integer
          format: int64
          example: 1516573243
        cfg_type:
          type: string
          enum:
          - learned
          - user_created
          - ground
          - federal
        priority:
          type: integer
          format: uint32
          example: 0
        match_counter:
          type: integer
          format: uint64
          example: 699
        last_match_timestamp:
          type: integer
          format: int64
          example: 1736811451
    RESTPolicyRuleConfigData:
      type: object
      required:
      - config
      properties:
        config:
          $ref: '#/components/schemas/RESTPolicyRuleConfig'
        replicate:
          type: boolean
          example: true
    RESTPolicyPromoteRequestData:
      type: object
      required:
      - request
      properties:
        request:
          $ref: '#/components/schemas/RESTPolicyPromoteRequest'
  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/