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

The Security API from Weka — 15 operation(s) for security.

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

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

This API exposes 26 operations across 15 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 5.1.

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

26 operations 15 paths 3 schemas 4 DELETE9 GET1 PATCH8 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 Security API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 26

Across 15 paths, the API surfaces 26 operations — 4 DELETE, 9 GET, 1 PATCH, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Security 26
GET
/security/defaultTokensExpiry
Get token expiration configuration
getTokensExpiry → 200401
POST
/security/defaultTokensExpiry
Configure token expiration settings
setTokensExpiry body → 200401
GET
/security/banner
Get login banner configuration
getLoginBanner → 200
PUT
/security/banner
Set or update the login banner
setLoginBanner body → 200401
POST
/security/banner/enable
Enable the login banner
enableLoginBanner → 200401
POST
/security/banner/disable
Disable the login banner
disableLoginBanner → 200401
GET
/security/tokensExpirydeprecated
Get token expiration times (deprecated)
getTokensExpiryDeprecated → 200401
POST
/security/joinToken
Get cluster join token
getJoinToken body → 200401
PUT
/security/caCert
Upload custom CA certificate for cluster authentication
setCaCert body → 200401
DELETE
/security/caCert
Remove custom CA certificate from cluster
unsetCaCert → 200401
GET
/security/caCert
Get CA certificate details and status
showCaCert → 200401
POST
/security/policies
Create a CIDR-based security policy
body → 200400401
GET
/security/policies
List all security policies
listSecPolicies → 200401
GET
/security/policies/{policy}
Get a specific security policy
getSecPolicy 1 param → 200401404
DELETE
/security/policies/{policy}
Delete a security policy
deleteSecPolicy 1 param → 200401404
PATCH
/security/policies/{policy}
Update an existing security policy
1 param body → 200400401404
POST
/security/policies/{policy}/duplicate
Duplicate an existing security policy
1 param body → 200401404
GET
/security/policies/test
Test security policy evaluation
testJoinSecurityPolicies 4 params → 200400401
DELETE
/security/join/{mode}/securityPolicy
Remove all security policies from cluster join configuration
resetJoinSecurityPolicies 1 param → 200401404
GET
/security/join/{mode}/securityPolicy
Get security policies for cluster joining
getJoinSecurityPolicies 1 param → 200401404
PUT
/security/join/{mode}/securityPolicy
Set cluster join security policies
setJoinSecurityPolicies 1 param body → 200401404
POST
/security/join/{mode}/securityPolicy/attach
Attach security policies to cluster join configuration
attachJoinSecurityPolicies 1 param body → 200401404
POST
/security/join/{mode}/securityPolicy/detach
Detach security policies from cluster join configuration
detachJoinSecurityPolicies 1 param body → 200401404
GET
/security/guiIdleTimeout
Get GUI idle timeout configuration
getGuiIdleTimeout → 200
PUT
/security/guiIdleTimeout
Configure GUI idle timeout
setGuiIdleTimeout body → 200400401
DELETE
/security/guiIdleTimeout
Reset GUI idle timeout to default
restoreGuiIdleTimeout → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are securityPolicy (16 properties), securityPolicyInfo (3 properties). Each schema is shown below with its type and property counts.

securityPolicy
object
16 properties
securityPolicyInfo
object
3 properties
userRole
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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