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

Weka NFS API

The NFS API from Weka — 21 operation(s) for nfs.

Weka NFS API is one of 45 APIs that Weka publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NFS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 29 operations across 21 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 5.1.

Requests are made against a single base URL, /api/v2.

29 operations 21 paths 2 schemas 3 DELETE9 GET5 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
5.1
Base URL
https://api.docs.weka.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Weka NFS API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 29

Across 21 paths, the API surfaces 29 operations — 3 DELETE, 9 GET, 5 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

NFS 29
GET
/nfs/permissions
Get all NFS permissions
getNfsPermissions 1 param → 200401
POST
/nfs/permissions
Create an NFS permission
addNfsPermission body → 200400401
GET
/nfs/permissions/{uid}
Get a specific NFS permission
getNfsPermission 1 param → 200401404
PUT
/nfs/permissions/{uid}
Update an NFS permission
updateNfsPermission 1 param body → 200400401404
DELETE
/nfs/permissions/{uid}
Remove an NFS permission
deleteNfsPermission 2 params → 200404
GET
/nfs/clientGroups
Get all NFS client groups
getClientGroups → 200401
POST
/nfs/clientGroups
Create an NFS client group
createClientGroup body → 200400401
GET
/nfs/clientGroups/{uid}
Get a specific NFS client group
getClientGroup 1 param → 200401404
DELETE
/nfs/clientGroups/{uid}
Remove an NFS client group
deleteClientGroup 1 param → 200401404
POST
/nfs/clientGroups/{uid}/rules
Create a rule for an NFS client group
addClientGroupRule 1 param body → 200400401404
DELETE
/nfs/clientGroups/{uid}/rules/{rule_uid}
Remove a rule from an NFS client group
deleteClientGroupRule 2 params → 200401404
PUT
/nfs/globalConfig
Update the global NFS configuration
updateNfsGlobalConfig body → 200400401404
GET
/nfs/globalConfig
Get the global NFS configuration
getNfsGlobalConfig → 200400401
GET
/nfs/debug
Get the NFS debug level
getNFSDebugLevel → 200400401
POST
/nfs/debug
Set the NFS debug level
setNFSDebugLevel body → 200400401
PUT
/nfs/kerberosService
Set up the NFS-Kerberos service
setupNfsKerberosService body → 200400401404
GET
/nfs/kerberosService
Get the NFS-Kerberos service configuration
getNfsKerberosService → 200400401
PUT
/nfs/kerberosMitRegistration
Register NFS with MIT Kerberos
setNfsMitKerberosRegistration body → 200400401404
PUT
/nfs/kerberosActiveDirectoryRegistration
Register NFS with Active Directory Kerberos
setNfsAdKerberosRegistration body → 200400401404
GET
/nfs/kerberosRegistration
Get the NFS-Kerberos registration configuration
getNfsKerberosRegistration → 200400401
PUT
/nfs/kerberosReset
Reset the Kerberos configuration for NFS
resetNfsKerberosConfiguration body → 200400401404
PUT
/nfs/useOnHostLdapClient
Set up host-based LDAP resolution for NFS
setNfsUseOnHostLdapClient body → 200400401404
PUT
/nfs/openLdapService
Set up NFS with OpenLDAP
setNfsOpenLdapConfiguration body → 200400401404
PUT
/nfs/activeDirectoryLdapService
Set up NFS with Active Directory LDAP
setNfsAdLdapConfiguration body → 200400401404
PUT
/nfs/activeDirectoryNoKrbLdapService
Set up Active Directory LDAP for ACLs (without Kerberos)
setNfsAdNoKrbLdapConfiguration body → 200400401404
GET
/nfs/ldapService
Get the LDAP configuration
getNfsLdapService → 200400401
PUT
/nfs/ldapReset
Reset the LDAP configuration
resetNfsLdapConfiguration body → 200400401404
PUT
/nfs/ldapImport
Import an LDAP configuration
importNfsLdapConfiguration body → 200400401404
POST
/nfs/ldapExport
Export an LDAP configuration
exportNfsLdapConfiguration body → 200400401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are nfsPermission (19 properties), clientGroup (4 properties). Each schema is shown below with its type and property counts.

clientGroup
object
4 properties
nfsPermission
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weka-nfs-api-openapi.yml Raw ↑

Other APIs Weka publishes across the network.

Weka Active Directory API
Weka Alerts API
Weka Catalog API
Weka Cluster API
Weka Containers API
Weka DataService API
Weka Default network API
Weka Drive API
Weka Events API
Weka Failure domains API
Weka Filesystem API
Weka Filesystem group API