NeuVector

NeuVector Compliance API

Operations about Compliance

Documentation GitHub OpenAPI

Operations 12

GET /v1/bench/host/{id}/docker Docker bench #

POST /v1/bench/host/{id}/docker Docker bench run #

GET /v1/bench/host/{id}/kubernetes Kubernetes bench #

POST /v1/bench/host/{id}/kubernetes Kubernetes bench run #

GET /v1/compliance/profile Get compliance profile list #

GET /v1/compliance/profile/{name} Get compliance profile detail #

PATCH /v1/compliance/profile/{name} Configure compliance profile #

PATCH /v1/compliance/profile/{name}/entry/{check} Configure compliance profile entry #

DELETE /v1/compliance/profile/{name}/entry/{check} Delete compliance profile entry #

GET /v1/custom_check Get custom check scripts of all groups #

GET /v1/custom_check/{group} GET custom check scripts of the specified group #

PATCH /v1/custom_check/{group} Update custom check scripts of the specified group #

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

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 Compliance API
  contact:
    email: support@neuvector.com
tags:
- name: Compliance
  description: Operations about Compliance
paths:
  /v1/bench/host/{id}/docker:
    get:
      tags:
      - Compliance
      summary: Docker bench
      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/RESTBenchReport'
      operationId: getV1BenchHostByIdDocker
      x-operation-id-source: derived
    post:
      tags:
      - Compliance
      summary: Docker bench run
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Host ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      operationId: postV1BenchHostByIdDocker
      x-operation-id-source: derived
  /v1/bench/host/{id}/kubernetes:
    get:
      tags:
      - Compliance
      summary: Kubernetes bench
      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/RESTBenchReport'
      operationId: getV1BenchHostByIdKubernetes
      x-operation-id-source: derived
    post:
      tags:
      - Compliance
      summary: Kubernetes bench run
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: id
        description: Host ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      operationId: postV1BenchHostByIdKubernetes
      x-operation-id-source: derived
  /v1/compliance/profile:
    get:
      tags:
      - Compliance
      summary: Get compliance profile list
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTComplianceProfilesData'
      operationId: getV1ComplianceProfile
      x-operation-id-source: derived
  /v1/compliance/profile/{name}:
    get:
      tags:
      - Compliance
      summary: Get compliance profile detail
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: name
        description: Profile name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTComplianceProfileData'
      operationId: getV1ComplianceProfileByName
      x-operation-id-source: derived
    patch:
      tags:
      - Compliance
      summary: Configure compliance profile
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: name
        description: Compliance profile name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTComplianceProfileConfigData'
        description: Compliance profile config data
        required: true
      operationId: patchV1ComplianceProfileByName
      x-operation-id-source: derived
  /v1/compliance/profile/{name}/entry/{check}:
    patch:
      tags:
      - Compliance
      summary: Configure compliance profile entry
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: name
        description: Compliance profile name
        required: true
        schema:
          type: string
      - in: path
        name: check
        description: Compliance profile entry check name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTComplianceProfileEntryConfigData'
        description: Compliance profile entry data
        required: true
      operationId: patchV1ComplianceProfileByNameEntryByCheck
      x-operation-id-source: derived
    delete:
      tags:
      - Compliance
      summary: Delete compliance profile entry
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: name
        description: Compliance profile name
        required: true
        schema:
          type: string
      - in: path
        name: check
        description: Compliance profile entry check name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      operationId: deleteV1ComplianceProfileByNameEntryByCheck
      x-operation-id-source: derived
  /v1/custom_check:
    get:
      tags:
      - Compliance
      summary: Get custom check scripts of all groups
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCustomCheckListData'
      operationId: getV1CustomCheck
      x-operation-id-source: derived
  /v1/custom_check/{group}:
    get:
      tags:
      - Compliance
      summary: GET custom check scripts of the specified group
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: group
        description: Script config name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCustomCheckData'
      operationId: getV1CustomCheckByGroup
      x-operation-id-source: derived
    patch:
      tags:
      - Compliance
      summary: Update custom check scripts of the specified group
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: group
        description: Script config name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTCustomCheckConfigData'
        description: Script config data
        required: true
      operationId: patchV1CustomCheckByGroup
      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
    RESTBenchReport:
      type: object
      required:
      - run_timestamp
      - run_at
      - 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
        cis_version:
          type: string
          example: 1.5.1
        items:
          type: array
          items:
            $ref: '#/components/schemas/RESTBenchItem'
    RESTCustomCheckListData:
      type: object
      required:
      - configs
      properties:
        configs:
          type: array
          items:
            $ref: '#/components/schemas/RESTCustomChecks'
    RESTCustomChecks:
      type: object
      required:
      - group
      - scripts
      properties:
        group:
          type: string
          example: containers
        enabled:
          type: boolean
          example: false
        writable:
          type: boolean
          example: false
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/RESTCustomCheck'
    RESTComplianceProfileEntry:
      type: object
      required:
      - test_number
      - tags
      properties:
        test_number:
          type: string
          example: ''
        tags:
          type: array
          items:
            type: string
            example: ''
    RESTComplianceProfileConfigData:
      type: object
      required:
      - config
      properties:
        config:
          $ref: '#/components/schemas/RESTComplianceProfileConfig'
    RESTCustomCheckData:
      type: object
      required:
      - config
      properties:
        config:
          $ref: '#/components/schemas/RESTCustomChecks'
    RESTComplianceProfile:
      type: object
      required:
      - name
      - disable_system
      - entries
      properties:
        name:
          type: string
          example: default
        disable_system:
          type: boolean
          example: false
        entries:
          type: array
          items:
            $ref: '#/components/schemas/RESTComplianceProfileEntry'
        cfg_type:
          type: string
          enum:
          - user_created
          - ground
    RESTComplianceProfileConfig:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          example: default
        disable_system:
          type: boolean
          example: false
        entries:
          type: array
          items:
            $ref: '#/components/schemas/RESTComplianceProfileEntry'
    RESTComplianceProfilesData:
      type: object
      required:
      - profiles
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/RESTComplianceProfile'
    RESTCustomCheck:
      type: object
      required:
      - name
      - script
      properties:
        name:
          type: string
          example: node
        script:
          type: string
          example: 'uname -r '
    RESTCustomCheckConfig:
      type: object
      required:
      - add
      - delete
      - update
      properties:
        add:
          $ref: '#/components/schemas/RESTCustomChecks'
        delete:
          $ref: '#/components/schemas/RESTCustomChecks'
        update:
          $ref: '#/components/schemas/RESTCustomChecks'
    RESTCustomCheckConfigData:
      type: object
      required:
      - config
      properties:
        config:
          $ref: '#/components/schemas/RESTCustomCheckConfig'
    RESTComplianceProfileEntryConfigData:
      type: object
      required:
      - config
      properties:
        config:
          $ref: '#/components/schemas/RESTComplianceProfileEntry'
    RESTComplianceProfileData:
      type: object
      required:
      - profile
      properties:
        profile:
          $ref: '#/components/schemas/RESTComplianceProfile'
  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/