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

The Catalog API from Weka — 12 operation(s) for catalog.

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

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

This API exposes 12 operations across 12 paths. It is described by OpenAPI 3.0.3, at version 5.1.

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

12 operations 12 paths 0 schemas 10 GET2 POST

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 Catalog API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 10 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Catalog 12
POST
/catalog/query
Run catalog query with nested filters
postCatalogQuery body → 200400401503
POST
/catalog/query/diff
Compare two point-in-time snapshots and return differences
postCatalogQueryDiff body → 200400401404503504
GET
/catalog/stats/usageByUser
Get filesystem usage statistics by user
getCatalogUsageByUser 5 params → 200401503
GET
/catalog/stats/usageByGroup
Get filesystem usage statistics by group
getCatalogUsageByGroup 3 params → 200401
GET
/catalog/snapshots/{fs_uuid}
Get list of snapshot metadata available for a filesystem in the catalog
getFilesystemSnapshots 1 param → 200401
GET
/catalog/stats/distributionByExtension
Get file distribution by extension
getCatalogDistributionByExtension 3 params → 200401
GET
/catalog/stats/filesBySize
Get files by size buckets
getCatalogFilesBySize 3 params → 200401500
GET
/catalog/stats/capacityByFileAge
Get capacity by file age
getCatalogCapacityByFileAge 3 params → 200401500
GET
/catalog/stats/dashboard
Get dashboard statistics
getCatalogDashboard 3 params → 200401
GET
/catalog/stats/directoryTree
Get hierarchical directory tree with size statistics
getCatalogDirectoryTree 6 params → 200401503
GET
/catalog/filesystem/metadata
Get filesystem capacity metadata history
getFilesystemMetadata 5 params → 200401500
GET
/catalog/filesystem/metadata/point-in-time
Get point-in-time filesystem capacity metadata
getPointInTimeFilesystemMetadata 2 params → 200401500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weka-catalog-api-openapi.yml Raw ↑

Other APIs Weka publishes across the network.

Weka Active Directory API
Weka Alerts 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
Weka Health API