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 File Monitor API

Operations about File Monitor

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

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

This API exposes 3 operations across 2 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.

3 operations 2 paths 5 schemas 2 GET1 PATCH

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 File Monitor 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 3

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

File Monitor 3

Operations about File Monitor

GET
/v1/file_monitor
Get a list of file monitors
1 param → 200
GET
/v1/file_monitor/{name}
Show file monitor
1 param → 200
PATCH
/v1/file_monitor/{name}
Update file monitor
2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RESTFileMonitorFilterConfig (5 properties), RESTFileMonitorFile (5 properties), RESTFileMonitorConfig (3 properties), RESTFileMonitorConfigData (1 property). Each schema is shown below with its type and property counts.

RESTFileMonitorFileData
object
1 property 1 required
RESTFileMonitorFile
object
5 properties 5 required
RESTFileMonitorConfigData
object
1 property 1 required
RESTFileMonitorConfig
object
3 properties
RESTFileMonitorFilterConfig
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-file-monitor-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