swagger: '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 Vulnerability API
  contact:
    email: support@neuvector.com
schemes:
- https
tags:
- name: Vulnerability
  description: Operations about Vulnerability management
paths:
  /v1/vulnerability/profile:
    get:
      tags:
      - Vulnerability
      summary: Get vulnerability profile list
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/RESTVulnerabilityProfilesData'
  /v1/vulnerability/profile/{name}:
    get:
      tags:
      - Vulnerability
      summary: Get vulnerability profile detail
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      produces:
      - application/json
      parameters:
      - in: path
        name: name
        description: Profile name
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/RESTVulnerabilityProfileData'
    patch:
      tags:
      - Vulnerability
      summary: Configure vulnerability profile
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      consumes:
      - application/json
      parameters:
      - in: path
        name: name
        description: Vulnerability profile name
        required: true
        type: string
      - in: body
        name: body
        description: Vulnerability profile config data
        required: true
        schema:
          $ref: '#/definitions/RESTVulnerabilityProfileConfigData'
      responses:
        '200':
          description: Success
  /v1/vulnerability/profile/{name}/entry:
    post:
      tags:
      - Vulnerability
      summary: Create the vulnerability profile entry
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: name
        description: Name of the vulnerability profile entry
        required: true
        type: string
      - in: body
        name: body
        description: Vulnerability profile entry data
        required: true
        schema:
          $ref: '#/definitions/RESTVulnerabilityProfileEntryConfigData'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/RESTVulnerabilityProfileEntryConfigData'
  /v1/vulnerability/profile/{name}/entry/{id}:
    patch:
      tags:
      - Vulnerability
      summary: Configure vulnerability profile entry
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      consumes:
      - application/json
      parameters:
      - in: path
        name: name
        description: Vulnerability profile name
        required: true
        type: string
      - in: path
        name: id
        description: Vulnerability profile entry id
        required: true
        type: integer
        format: uint32
      - in: body
        name: body
        description: Vulnerability profile entry data
        required: true
        schema:
          $ref: '#/definitions/RESTVulnerabilityProfileEntryConfigData'
      responses:
        '200':
          description: Success
    delete:
      tags:
      - Vulnerability
      summary: Delete vulnerability profile entry
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: name
        description: Vulnerability profile name
        required: true
        type: string
      - in: path
        name: id
        description: Vulnerability profile entry id
        required: true
        type: integer
        format: uint32
      responses:
        '200':
          description: Success
definitions:
  RESTVulnerabilityProfilesData:
    type: object
    required:
    - profiles
    properties:
      profiles:
        type: array
        items:
          $ref: '#/definitions/RESTVulnerabilityProfile'
  RESTVulnerabilityProfileData:
    type: object
    required:
    - profile
    properties:
      profile:
        $ref: '#/definitions/RESTVulnerabilityProfile'
  RESTVulnerabilityProfileConfigData:
    type: object
    required:
    - config
    properties:
      config:
        $ref: '#/definitions/RESTVulnerabilityProfileConfig'
  RESTVulnerabilityProfileEntry:
    type: object
    required:
    - id
    - name
    - comment
    - days
    - domains
    - images
    properties:
      id:
        type: integer
        format: uint32
        example: 1003
      name:
        type: string
        example: CVE-2020-29661
      comment:
        type: string
        example: Accepted by admin at Dec 09, 2021 12:00:02 from Vulnerabilities page
      days:
        type: integer
        format: uint
        example: 0
      domains:
        type: array
        items:
          type: string
        example:
        - domain1
        - domain2
      images:
        type: array
        items:
          type: string
        example: []
  RESTVulnerabilityProfileEntryConfigData:
    type: object
    required:
    - config
    properties:
      config:
        $ref: '#/definitions/RESTVulnerabilityProfileEntry'
  RESTVulnerabilityProfileConfig:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        example: default
      entries:
        type: array
        items:
          $ref: '#/definitions/RESTVulnerabilityProfileEntry'
  RESTVulnerabilityProfile:
    type: object
    required:
    - name
    - entries
    properties:
      name:
        type: string
        example: default
      entries:
        type: array
        items:
          $ref: '#/definitions/RESTVulnerabilityProfileEntry'
      cfg_type:
        type: string
        enum:
        - user_created
        - ground
securityDefinitions:
  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/