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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NeuVector

NeuVector File API

Operations about File

Documentation Provider Profile APIs.io OpenAPI GitHub

NeuVector File 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 18 operations across 15 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

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

18 operations 15 paths 12 schemas 3 GET15 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
Contact
support@neuvector.com
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

NeuVector File 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 18

Across 15 paths, the API surfaces 18 operations — 3 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

File 18

Operations about File

POST
/v1/file/compliance/profile
Export compliance profile as a yaml format. The exported yaml file can be imported by CRD or REST API to update the compliance profile.
2 params → 200
POST
/v1/file/admission
Export admission control configuration as a yaml format. The exported yaml file can be imported by CRD (non-fed scope only) or REST API to update the admission control settings.
2 params → 200
POST
/v1/file/admission/config
import admission config
3 params → 200
POST
/v1/file/response/rule
Export non-group-dependent (federated) response rules as a yaml format. The exported yaml file can be imported by CRD (non-fed scope only) or REST API to update the response rules.
2 params → 200
POST
/v1/file/response/rule/config
import non-group-dependent response rules
3 params → 200
GET
/v1/file/config
Download a configure file
→ 200
POST
/v1/file/config
Upload configure file
3 params → 200
POST
/v1/file/fed_config
Export federated webhooks configuration as a yaml format
2 params → 200
POST
/v1/file/dlp
Export (federated) DLP configuration as a yaml format. The exported yaml file can be imported by CRD (non-fed scope only) or REST API to update the DLP configurations.
2 params → 200
POST
/v1/file/dlp/config
import DLP config
3 params → 200
POST
/v1/file/vulnerability/profile
Export vulnerability profile as a yaml format. The exported yaml file can be imported by CRD or REST API to update the compliance profile.
2 params → 200
POST
/v1/file/waf
Export (federated) WAF configuration as a yaml format. The exported yaml file can be imported by CRD (non-fed scope only) or REST API to update the WAF configurations.
2 params → 200
POST
/v1/file/waf/config
import waf config
3 params → 200
GET
/v1/file/group
(Obsolete, please use POST method.) Export the yaml format configuration file ( used for CRD or group policy ).
1 param → 200
POST
/v1/file/group
Export (federated) group configuration as a yaml format. The exported yaml file can be imported by CRD (non-fed scope only) or REST API to update the group policy.
2 params → 200
GET
/v1/file/group/config
Get import status
→ 200
POST
/v1/file/group/config
import group policy
3 params → 200
POST
/v1/csp/file/support
Export support config tarball in gz format
→ 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are RESTImportTask (8 properties), RESTGroupExport (5 properties), RESTRemoteExportOptions (3 properties), RESTAdmCtrlRulesExport (3 properties). Each schema is shown below with its type and property counts.

RESTDlpSensorExport
object
2 properties 1 required
RESTVulnProfilesExport
object
2 properties
RESTCompProfilesExport
object
2 properties
RESTAdmCtrlRulesExport
object
3 properties
RESTGroupExport
object
5 properties 1 required
RESTRemoteExportData
object
1 property
RESTRemoteExportOptions
object
3 properties 2 required
RESTImportTaskData
object
1 property 1 required
RESTWafSensorExport
object
2 properties 1 required
RESTResponseRulesExport
object
2 properties
RESTImportTask
object
8 properties 3 required
RESTFedConfigExport
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-file-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
AE Profile APIs.io
NeuVector Apikey API
AE Profile APIs.io
NeuVector Authentication API
AE Profile APIs.io
NeuVector Compliance API
AE Profile APIs.io
NeuVector compliance profile. The payload body is the content of the compliance profile yaml file. API
AE Profile APIs.io
NeuVector compliance profile. The payload body is the content of the vulnerability profile yaml file. API
AE Profile APIs.io
NeuVector Container API
AE Profile APIs.io
NeuVector Controller API
AE Profile APIs.io
NeuVector DLP API
AE Profile APIs.io
NeuVector Enforcer API
AE Profile APIs.io
NeuVector EULA API
AE Profile APIs.io
NeuVector Federation API
AE Profile APIs.io
#File
← Back to N APIs
API Details
ID
neuvector:neuvector-file-api
Base URL
https://localhost:10443
Docs
https://open-docs.neuvector.com/
Provider
NeuVector
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network