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 Filesystem API

The Filesystem API from Weka — 16 operation(s) for filesystem.

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

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

This API exposes 22 operations across 16 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 5.1.

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

22 operations 16 paths 5 schemas 5 DELETE7 GET7 POST3 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 Filesystem API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 22

Across 16 paths, the API surfaces 22 operations — 5 DELETE, 7 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Filesystem 22
GET
/fileSystems
List all filesystems
getFileSystems 1 param → 200401
POST
/fileSystems
Create filesystem
createFileSystem body → 200400401
GET
/fileSystems/{uid}
Get filesystem details
getFileSystem 2 params → 200401404
PUT
/fileSystems/{uid}
Update a filesystem
updateFileSystem 1 param body → 200400401
DELETE
/fileSystems/{uid}
Remove a filesystem
deleteFileSystem 2 params → 200400401
POST
/fileSystems/{uid}/mountToken
Obtain mount token for filesystem
getMountToken 1 param body → 200400401403404
POST
/fileSystems/{uid}/objectStoresdeprecated
Attach an object store bucket (Deprecated)
attachObsToFs 1 param body → 200400401404
POST
/fileSystems/{uid}/objectStoreBuckets
Attach an object store bucket
attachObsBucketToFs 1 param body → 200400401404
DELETE
/fileSystems/{uid}/objectStores/{obs_uid}deprecated
Detach an object store bucket (Deprecated)
detachObsFromFS 2 params → 200400401404
GET
/fileSystems/{inode_id}/getPath
Get path by inode ID
filesystemResolveInode 1 param → 200401404
GET
/fileSystems/{inode_id}/resolvedeprecated
Get filesystem by inode ID (Deprecated)
filesystemResolveInode 1 param → 200401404
DELETE
/fileSystems/{uid}/objectStoreBuckets/{obs_uid}
Detach object store bucket from filesystem
detachObsBucketFromFS 2 params → 200400401404
POST
/fileSystems/download
Download filesystem from object store
downloadFS body → 200400401
GET
/fileSystems/thinProvisionReserve
Get thin-provisioning reserve status
getFileSystemsThinProvisionReserveStatus → 200401
PUT
/fileSystems/thinProvisionReserve/{org_uid}
Set thin-provisioning reserve
setFileSystemsThinProvisionReserve 1 param body → 200400404
DELETE
/fileSystems/thinProvisionReserve/{org_uid}
Remove thin-provisioning reserve
deleteFileSystemsThinProvisionReserve 1 param → 200400404
DELETE
/fileSystems/{uid}/securityPolicy
Remove all security policies from a filesystem
resetFsSecurityPolicies 1 param → 200401404
GET
/fileSystems/{uid}/securityPolicy
Get security policies for a filesystem
getFsSecurityPolicies 1 param → 200401404
PUT
/fileSystems/{uid}/securityPolicy
Set filesystem security policies
setFsSecurityPolicies 1 param body → 200401404
POST
/fileSystems/{uid}/securityPolicy/attach
Attach security policies to a filesystem
attachFsSecurityPolicies 1 param body → 200401404
POST
/fileSystems/{uid}/securityPolicy/detach
Detach security policies from a filesystem
detachFsSecurityPolicies 1 param body → 200401404
GET
/fileSystems/freeSpaceInOrg
Get available space in an organization
getFreeSpaceInOrg → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are fileSystem (34 properties), filesystemResolve (8 properties), filesystemInodeGetPath (7 properties), ThinProvisionReserve (4 properties). Each schema is shown below with its type and property counts.

filesystemInodeGetPath
object
7 properties
securityPolicyInfo
object
3 properties
filesystemResolve
object
8 properties
ThinProvisionReserve
object
4 properties
fileSystem
object
34 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weka-filesystem-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 group API
Weka Health API