NeuVector

NeuVector Apikey API

The Apikey API from NeuVector — 2 operation(s) for apikey.

GitHub OpenAPI

Operations 4

GET /v1/api_key Gets a list of apikeys
POST /v1/api_key Creates an apikey
GET /v1/api_key/{accesskey} Gets an apikey
DELETE /v1/api_key/{accesskey} Delete apikey

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-apikey-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-apikey-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-apikey-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 Apikey API
  contact:
    email: support@neuvector.com
servers:
- url: https://localhost:10443/
tags:
- name: Apikey
paths:
  /v1/api_key:
    get:
      tags:
      - Apikey
      summary: Gets a list of apikeys
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTApikeysData'
    post:
      tags:
      - Apikey
      summary: Creates an apikey
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTApikeyGeneratedData'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RESTApikeyCreationData'
        description: Apikey information
        required: true
  /v1/api_key/{accesskey}:
    get:
      tags:
      - Apikey
      summary: Gets an apikey
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: accesskey
        description: Apikey access key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTApikeyData'
    delete:
      tags:
      - Apikey
      summary: Delete apikey
      security:
      - ApiKeyAuth: []
      - TokenAuth: []
      parameters:
      - in: path
        name: accesskey
        description: Apikey access key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
components:
  schemas:
    RESTApikeyGenerated:
      type: object
      required:
      - apikey_name
      - apikey_secret
      properties:
        apikey_name:
          type: string
          example: token-cicd-scan
        apikey_secret:
          type: string
          example: 0u+tVOWNPRfpCK7p9qz
    RESTApikeyGeneratedData:
      type: object
      required:
      - apikey
      properties:
        apikey:
          $ref: '#/components/schemas/RESTApikeyGenerated'
    RESTApikeyCreationData:
      type: object
      required:
      - apikey
      properties:
        apikey:
          $ref: '#/components/schemas/RESTApikeyCreation'
    RESTApikeyCreation:
      type: object
      required:
      - expiration_type
      - apikey_name
      - role
      properties:
        expiration_type:
          type: string
          example: never
        expiration_hours:
          type: integer
          format: uint32
          example: 1
        apikey_name:
          type: string
          example: token-cicd-scan
        description:
          type: string
          example: cicd image scanning
        role:
          type: string
          example: admin
        role_domains:
          type: object
          description: Object key is role and value is array of domains
          additionalProperties:
            type: array
            items:
              type: string
            example:
            - domain1
            - domain2
    RESTApikeyData:
      type: object
      required:
      - apikey
      properties:
        apikey:
          $ref: '#/components/schemas/RESTApikey'
    RESTApikey:
      type: object
      required:
      - expiration_type
      - apikey_name
      - role
      properties:
        expiration_type:
          type: string
          example: never
        expiration_hours:
          type: integer
          format: uint32
          example: 1
        apikey_name:
          type: string
          example: token-cicd-scan
        apikey_secret:
          type: string
          example: 0u+tVOWNPRfpCK7p9qz
        description:
          type: string
          example: cicd image scanning
        role:
          type: string
          example: admin
        role_domains:
          type: object
          description: Object key is role and value is array of domains
          additionalProperties:
            type: array
            items:
              type: string
            example:
            - domain1
            - domain2
        expiration_timestamp:
          type: integer
          format: int64
          example: 11515020888
        created_timestamp:
          type: integer
          format: int64
          example: 11515020888
        created_by_entity:
          type: string
          example: admin
    RESTApikeysData:
      type: object
      required:
      - apikeys
      - global_roles
      - domain_roles
      properties:
        apikeys:
          type: array
          items:
            $ref: '#/components/schemas/RESTApikey'
        global_roles:
          type: array
          items:
            type: string
          example:
          - admin
          - reader
        domain_roles:
          type: array
          items:
            type: string
          example:
          - role1
          - role2
  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/