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

The SMB API from Weka — 13 operation(s) for smb.

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

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

This API exposes 21 operations across 13 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.

21 operations 13 paths 2 schemas 6 DELETE5 GET6 POST4 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 SMB API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 13 paths, the API surfaces 21 operations — 6 DELETE, 5 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

SMB 21
GET
/smb
Get SMB cluster configuration
getSamba → 200401
POST
/smb
Create a new SMB cluster
setSamba body → 200400401
PUT
/smb
Modify SMB cluster settings
updateSamba body → 200400401
DELETE
/smb
Disable SMB cluster
clearSamba → 200401
GET
/smb/domains
Get trusted domain list
setSambaDomains → 200401
POST
/smb/domains
Add trusted domain to cluster
addSambaDomain body → 200400401
GET
/smb/mount
Get smb mount options
SmbShareOptions → 200401
GET
/smb/shares
Get all SMB shares
setSambaShares → 200401
POST
/smb/shares
Add SMB share
addShareToSamba body → 200400401
POST
/smb/activeDirectory
Join Active Directory domain
setSambaActiveDirectory body → 200
PUT
/smb/activeDirectory
Disconnect from Active Directory domain
deleteSambaActiveDirectory body → 200401
POST
/smb/debug
Configure SMB container logging verbosity
setSambaDebug body → 200400401
PUT
/smb/shares/{uid}
Modify share configuration
updateSambaShare 1 param body → 200400401
DELETE
/smb/shares/{uid}
Remove SMB share
deleteSambaShare 1 param → 200401404
DELETE
/smb/domains/{uid}
Remove trusted domain
deleteSambaDomain 1 param → 200401404
POST
/smb/users/{share_uid}/{user_type}
Grant share access to users
addUserToSamba 2 params body → 200401404
DELETE
/smb/users/reset/{share_uid}/{user_type}
Remove all users from the access list
resetSambaUsers 2 params → 200401404
DELETE
/smb/users/{share_uid}/{user_type}/{user}
Remove specific user from share access
deleteSambaUser 3 params → 200401404
GET
/smb/containersAreReady
Verify SMB container readiness
getSambaContainersAreReady → 200400401
PUT
/smb/servers
Add containers to SMB cluster
addSambaServers body → 200401
DELETE
/smb/servers
Remove containers from SMB cluster
deleteSambaServers 1 param → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are smbShare (23 properties), smbDomain (6 properties). Each schema is shown below with its type and property counts.

smbShare
object
23 properties
smbDomain
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weka-smb-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