Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NeuVector Sniffer API

Operations about Sniffer

NeuVector Sniffer API is one of 31 APIs that NeuVector publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sniffer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

Requests are made against the base URL https://localhost:10443.

6 operations 4 paths 5 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
5.6.0
Base URL
https://localhost:10443
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

NeuVector Sniffer API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Apikey (ApiKeyAuth). An API key is passed in the header as X-Auth-Token (TokenAuth).

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sniffer 6

Operations about Sniffer

GET
/v1/sniffer
Get a list of sniffers
1 param → 200
POST
/v1/sniffer
Sniffer start
2 params → 200
GET
/v1/sniffer/{id}
Show sniffer
1 param → 200
DELETE
/v1/sniffer/{id}
Delete sniffer
1 param → 200
PATCH
/v1/sniffer/stop/{id}
Stop sniffer
1 param → 200
GET
/v1/sniffer/{id}/pcap
Sniffer get a pcap file
1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RESTSnifferInfo (9 properties), RESTSnifferArgs (3 properties), RESTSnifferArgsData (1 property), RESTSnifferData (1 property). Each schema is shown below with its type and property counts.

RESTSnifferInfo
object
9 properties 9 required
RESTSniffersData
object
1 property 1 required
RESTSnifferData
object
1 property 1 required
RESTSnifferArgs
object
3 properties
RESTSnifferArgsData
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-sniffer-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
NeuVector Apikey API
NeuVector Authentication API
NeuVector Compliance API
NeuVector compliance profile. The payload body is the content of the compliance profile yaml file. API
NeuVector compliance profile. The payload body is the content of the vulnerability profile yaml file. API
NeuVector Container API
NeuVector Controller API
NeuVector DLP API
NeuVector Enforcer API
NeuVector EULA API
NeuVector Federation API