NeuVector

NeuVector Host API

Operations about Host

GitHub OpenAPI

Operations 3

GET /v1/host Get a list of hosts #
GET /v1/host/{id} Show host #
GET /v1/host/{id}/compliance Show host compliance report #

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-host-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-host-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-host-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 Host API
  contact:
    email: support@neuvector.com
tags:
- name: Host
  description: Operations about Host
paths:
  /v1/host:
    get:
      tags:
      - Host
      summary: Get a list of hosts
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTHostsData'
      operationId: getV1Host
      x-operation-id-source: derived
  /v1/host/{id}:
    get:
      tags:
      - Host
      summary: Show host
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Host ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTHostData'
      operationId: getV1HostById
      x-operation-id-source: derived
  /v1/host/{id}/compliance:
    get:
      tags:
      - Host
      summary: Show host compliance report
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Host ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTComplianceData'
      operationId: getV1HostByIdCompliance
      x-operation-id-source: derived
components:
  schemas:
    RESTBenchItem:
      type: object
      required:
      - catalog
      - type
      - level
      - test_number
      - profile
      - scored
      - automated
      - description
      - message
      - remediation
      - group
      properties:
        catalog:
          type: string
          example: docker
        type:
          type: string
          example: ''
        level:
          type: string
          example: INFO
        test_number:
          type: string
          example: '1'
        profile:
          type: string
          example: Level 1
        scored:
          type: boolean
          example: true
        automated:
          type: boolean
          example: true
        description:
          type: string
          example: General Configuration
        message:
          type: array
          items:
            type: string
            example: Host Configuration
        remediation:
          type: string
          example: ''
        group:
          type: string
          example: nv.calico
    RESTIPAddr:
      type: object
      required:
      - ip
      - ip_prefix
      - gateway
      properties:
        ip:
          type: string
          example: 192.168.209.197
        ip_prefix:
          type: integer
          example: 32
        gateway:
          type: string
          example: ''
    RESTScanBrief:
      type: object
      required:
      - status
      - high
      - medium
      - result
      - scanned_timestamp
      - scanned_at
      - base_os
      - scanner_version
      - cvedb_create_time
      properties:
        status:
          type: string
          example: scheduled
        high:
          type: integer
          example: 0
        medium:
          type: integer
          example: 0
        result:
          type: string
          example: success
        scanned_timestamp:
          type: integer
          format: int64
          example: 1516561253
        scanned_at:
          type: string
          format: date-time
          example: 2018-01-21 19:00:53+00:00
        base_os:
          type: string
          example: ubuntu:16.04
        scanner_version:
          type: string
          example: '1.011'
        cvedb_create_time:
          type: string
          format: date-time
          example: 2018-06-20 19:00:53+00:00
    RESTHostsData:
      type: object
      required:
      - hosts
      properties:
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/RESTHost'
    RESTComplianceData:
      type: object
      required:
      - run_timestamp
      - run_at
      - kubernetes_cis_category
      - kubernetes_cis_version
      - docker_cis_version
      - items
      properties:
        run_timestamp:
          type: integer
          format: int64
          example: 1516561253
        run_at:
          type: string
          format: date-time
          example: 2018-06-21 19:00:53+00:00
        kubernetes_cis_category:
          type: string
          example: ''
        kubernetes_cis_version:
          type: string
          example: 1.5.1
        docker_cis_version:
          type: string
          example: 1.2.0
        items:
          type: array
          items:
            $ref: '#/components/schemas/RESTBenchItem'
    RESTHost:
      type: object
      required:
      - name
      - id
      - runtime
      - runtime_version
      - runtime_api_version
      - platform
      - os
      - kernel
      - cpus
      - memory
      - cgroup_version
      - containers
      - interfaces
      - state
      - cap_docker_bench
      - cap_kube_bench
      - policy_mode
      - profile_mode
      - scan_summary
      - storage_driver
      - labels
      - annotations
      properties:
        name:
          type: string
          example: ubuntu64
        id:
          type: string
          example: 2AU7:TIEN:O5KX:QK56:LFQP:IJSV:FXBN:QJV7:XPAH
        runtime:
          type: string
          example: docker
        runtime_version:
          type: string
          example: 1.10.2
        runtime_api_version:
          type: string
          example: '1.22'
        platform:
          type: string
          example: Docker
        os:
          type: string
          example: Ubuntu 14.04.3 LTS
        kernel:
          type: string
          example: 3.19.0-25-generic
        cpus:
          type: integer
          format: int64
          example: 1
        memory:
          type: integer
          format: int64
          example: 2089816064
        cgroup_version:
          type: integer
          example: 1
        containers:
          type: integer
          example: 107
        interfaces:
          type: object
          description: map key is string type like "eth0"
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/RESTIPAddr'
        state:
          type: string
          example: ''
        cap_docker_bench:
          type: boolean
          example: true
        cap_kube_bench:
          type: boolean
          example: true
        docker_bench_status:
          type: string
          example: running
        kube_bench_status:
          type: string
          example: scheduled
        policy_mode:
          type: string
          example: Discover
        profile_mode:
          type: string
          example: Discover
        scan_summary:
          $ref: '#/components/schemas/RESTScanBrief'
        storage_driver:
          type: string
          example: aufs
        labels:
          type: object
          description: map key is string type
          additionalProperties:
            type: string
          example:
            beta.kubernetes.io/os: linux
        annotations:
          type: object
          description: map key is string type
          additionalProperties:
            type: string
          example:
            kubeadm.alpha.kubernetes.io/cri-socket: /var/run/dockershim.sock
    RESTHostData:
      type: object
      required:
      - host
      properties:
        host:
          $ref: '#/components/schemas/RESTHost'
  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/