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

The S3 API from Weka — 29 operation(s) for s3.

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

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

This API exposes 53 operations across 29 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 5.1.

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

53 operations 29 paths 1 schemas 12 DELETE15 GET16 POST10 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 S3 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 53

Across 29 paths, the API surfaces 53 operations — 12 DELETE, 15 GET, 16 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

S3 53
GET
/s3
Get S3 cluster information
getS3Cluster → 200400401
POST
/s3
Create an S3 cluster
createS3Cluster body → 200400401
PUT
/s3
Update an S3 cluster
updateS3Cluster body → 200400401
DELETE
/s3
Delete an S3 cluster
deleteS3Cluster 1 param → 200400401
GET
/s3/tenantSetup
Get S3 settings for the calling tenant
getS3TenantSetup → 200400401
PUT
/s3/tenantSetup
Update S3 settings for the calling tenant
setS3TenantSetup body → 200400401
GET
/s3/buckets
Get S3 buckets
getS3Buckets → 200400401
POST
/s3/buckets
Add an S3 bucket
createS3Bucket body → 200400401
GET
/s3/userPolicies
Get S3 user policies
getuserPolicies → 200400401
DELETE
/s3/buckets/{bucket}
Delete an S3 bucket
destroyS3Bucket 2 params → 200400401
GET
/s3/policies
Get S3 IAM policies
getS3Policies → 200400401
POST
/s3/policies
Add an S3 IAM policy
createS3Policy body → 200400401
GET
/s3/policies/{policy}
Get S3 IAM policy details
getS3Policy 1 param → 200400401
DELETE
/s3/policies/{policy}
Delete an S3 IAM policy
deleteS3Policy 1 param → 200400401
POST
/s3/policies/attach
Attach an S3 IAM policy to a user
attachS3Policy body → 200400401
POST
/s3/policies/detach
Detach an S3 IAM policy from a user
detachS3Policy body → 200400401
GET
/s3/serviceAccounts
Get S3 service accounts
getS3ServiceAccounts → 200400401
POST
/s3/serviceAccounts
Add an S3 service account
createS3ServiceAccount body → 200400401
GET
/s3/serviceAccounts/{access_key}
Get S3 service account details
getServiceAccount 1 param → 200400401
DELETE
/s3/serviceAccounts/{access_key}
Remove an S3 service account
deleteS3ServiceAccount 1 param → 200400401
POST
/s3/sts
Create an S3 STS token
s3StsCreate body → 200400401
POST
/s3/buckets/{bucket}/lifecycle/rules
Add a lifecycle rule
s3CreateLifecycleRule 1 param body → 200400401
DELETE
/s3/buckets/{bucket}/lifecycle/rules
Delete lifecycle rules
s3DeleteAllLifecycleRules 1 param → 200400401
GET
/s3/buckets/{bucket}/lifecycle/rules
Get lifecycle rules
s3ListAllLifecycleRules 1 param → 200400401
DELETE
/s3/buckets/{bucket}/lifecycle/rules/{rule}
Delete a lifecycle rule
s3DeleteLifecycleRule 2 params → 200400401
GET
/s3/buckets/{bucket}/policy
Get S3 bucket policy
getS3BucketPolicy 1 param → 200400401
PUT
/s3/buckets/{bucket}/policy
Set S3 bucket policy
setS3BucketPolicy 1 param body → 200400401
GET
/s3/buckets/{bucket}/policyJson
Get S3 bucket policy (JSON)
getS3BucketPolicyJson 1 param → 200400401
PUT
/s3/buckets/{bucket}/policyJson
Set S3 bucket policy (JSON)
setS3BucketPolicyJson 1 param body → 200400401
PUT
/s3/buckets/{bucket}/quota
Set S3 bucket quota
setS3BucketQuota 1 param body → 200400401
DELETE
/s3/buckets/{bucket}/quota
Unset S3 bucket quota
unsetS3BucketQuota 1 param → 200400401
GET
/s3/containersAreReady
Get container readiness
gets3ContainersAreReady → 200400401
POST
/s3/hostsdeprecated
Add servers to S3 cluster - deprecated, use POST /s3/containers
addS3Hosts body → 200400401
DELETE
/s3/hostsdeprecated
Remove servers from S3 cluster - deprecated use /s3/containers
deleteS3Hosts 1 param → 200400401
POST
/s3/containers
Add container to S3 cluster
addS3Containers body → 200400401
DELETE
/s3/containers
Remove containers
deleteS3Containers 1 param → 200400401
GET
/s3/debug
Get logging verbosity
gets3DebugLevel → 200400401
POST
/s3/debug
Set logging verbosity
sets3DebugLevel body → 200400401
POST
/s3/auditWebhook/enable
Enable S3 audit webhook
enableS3AuditWebhook body → 200400401
POST
/s3/auditWebhook/disable
Disable S3 audit webhook
disableS3AuditWebhook → 200400401
GET
/s3/auditWebhook
Get S3 audit webhook configuration
getS3AuditWebhook → 200400401
POST
/s3/oidc
Add S3 OIDC configuration
addS3OIDC body → 200400401
PUT
/s3/oidc
Update S3 OIDC configuration
updateS3OIDC body → 200400401
DELETE
/s3/oidc
Remove S3 OIDC configuration
removeS3OIDC → 200400401
GET
/s3/oidc
Get S3 OIDC configuration
getS3OIDC → 200400401
POST
/s3/ldapImportUser
Import LDAP user for S3 access
ldapCreateS3User → 200400401409
PUT
/s3/ldapImportUser
Update an S3 user through LDAP authentication
ldapUpdateS3User → 200400401404
DELETE
/s3/ldapImportUser
Remove an S3 user through LDAP username
ldapDeleteS3User → 200400401
POST
/s3/{tenantId}/ldapImportUser
Import LDAP user for S3 access in specific tenant
ldapCreateS3UserForTenant 1 param → 200400401409
PUT
/s3/{tenantId}/ldapImportUser
Update an S3 user through LDAP authentication in specific tenant
ldapUpdateS3UserForTenant 1 param → 200400401404
DELETE
/s3/{tenantId}/ldapImportUser
Remove an S3 user through LDAP username in specific tenant
ldapDeleteS3UserForTenant 1 param → 200400401
PUT
/s3/refresh-imported
Refresh all LDAP S3 users
refreshS3ImportedUsers → 200400401
PUT
/s3/{tenantId}/refresh-imported
Refresh all LDAP S3 users for a specific tenant
refreshS3ImportedUsersForTenant 1 param → 200400401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is s3Bucket (5 properties). Each schema is shown below with its type and property counts.

s3Bucket
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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