Skip to main content
The Metadata Service is the core service responsible for managing file metadata, encryption key wrapping (DEK), and cache synchronization within the Flux platform.
Internal Network Only: This endpoint is accessible exclusively from the internal network (e.g., meta.internal:8080). It is not exposed to the public internet. Do not attempt to call it from client-side applications.

​
API conventions

All Flux API endpoints follow a strict set of conventions.

​
Base path and versioning

Every endpoint starts with /api/ followed by the API version:
The current version is v1, so all endpoints are prefixed with:

​
Naming rules

Endpoint paths must not contain hyphens. Use concatenated words instead.

​
HTTP methods

Each endpoint typically supports up to three standard methods: Additional methods may be available depending on the endpoint’s use case.

​
Query parameters

GET endpoints may accept query parameters for filtering and pagination:

​
Service architecture

The Metadata Service handles three main areas:

File metadata

CRUD operations for file metadata records.

DEK management

Wrap and unwrap Data Encryption Keys using the master key.

Statistics

Aggregate statistics across all stored files.

​
Experimental endpoints

Experimental

Cache sync, prefetch, and invalidation endpoints. These are experimental and may not be included in the main API.
Experimental endpoints are prefixed with /api/v1/e/ and are subject to change or removal without notice.