# Flux Developer Docs

## Docs

- [Flux Pass admin API: users, entitlements, stats](https://meta.fluxdrop.pl/api/fluxpass/admin.md): Admin-only Flux Pass endpoints for listing users, viewing DROP service entitlements, and pulling platform-wide statistics behind the internal secret.
- [Flux Pass audit logs API for user activity](https://meta.fluxdrop.pl/api/fluxpass/audit.md): Query the authenticated user's Flux Pass audit log of logins, sessions, and account changes with pagination and action-type filtering.
- [Flux Pass authentication: register, login, 2FA, tokens](https://meta.fluxdrop.pl/api/fluxpass/auth.md): Flux Pass auth endpoints for user registration, login, logout, email verification codes, TOTP-based 2FA, and access token refresh flows.
- [Flux Pass connect API for service entitlements](https://meta.fluxdrop.pl/api/fluxpass/connect.md): Check, enable, and disable a user's connection to Flux services such as DROP and inspect their tier and premium entitlement status.
- [Flux Pass health check endpoint for monitoring](https://meta.fluxdrop.pl/api/fluxpass/health.md): The Flux Pass `GET /health` endpoint reports service name, version, and status for uptime monitoring, load balancer checks, and rate-limited probes.
- [Flux Pass OAuth sign-in with GitHub, Google, Microsoft](https://meta.fluxdrop.pl/api/fluxpass/oauth.md): Exchange OAuth authorization codes from GitHub, Google, or Microsoft for Flux Pass tokens, auto-creating or linking accounts to existing users.
- [Flux Pass overview: shared auth API for Flux apps](https://meta.fluxdrop.pl/api/fluxpass/overview.md): Architecture and conventions for Flux Pass, the NestJS public auth API powering registration, sessions, OAuth, entitlements, payments, and rate limits.
- [Flux Pass payments API: Polar checkout and webhooks](https://meta.fluxdrop.pl/api/fluxpass/payments.md): Start Polar checkout sessions, open the customer portal, and handle subscription webhooks for Flux Pass pro and pro-lite plans in USD and PLN.
- [Flux Pass user API: avatars, domains, subscriptions](https://meta.fluxdrop.pl/api/fluxpass/user.md): Manage the authenticated user's profile in Flux Pass, including avatar upload and retrieval, custom domains, connected services, and active subscriptions.
- [DEK wrap and unwrap endpoints for file encryption](https://meta.fluxdrop.pl/api/metadata/dek.md): Wrap and unwrap Data Encryption Keys with the Flux Metadata Service master key during internal file upload and download flows on VPS 20.
- [Experimental Valkey cache sync and prefetch endpoints](https://meta.fluxdrop.pl/api/metadata/experimental.md): Experimental Flux Metadata Service endpoints for Valkey cache bulk sync, prefetch, and invalidation. Subject to change or removal without notice.
- [File metadata create, retrieve, and delete endpoints](https://meta.fluxdrop.pl/api/metadata/meta.md): Create, retrieve, and delete file metadata records in the Flux Metadata Service, including encrypted filenames, sizes, and MIME types.
- [Metadata Service overview: internal API for file metadata](https://meta.fluxdrop.pl/api/metadata/overview.md): Introduction to the Flux Metadata Service, its internal network model, base path versioning, and naming conventions for all v1 endpoints.
- [Aggregate file count and storage size statistics](https://meta.fluxdrop.pl/api/metadata/stats.md): Retrieve aggregate statistics from the Flux Metadata Service, including total file count and combined storage size across all stored files.
- [Flux developer documentation](https://meta.fluxdrop.pl/index.md): Internal developer docs for the Flux encrypted file platform, covering the Metadata Service, DEK wrapping, Valkey caching, and platform architecture.
- [Metadata Service quickstart](https://meta.fluxdrop.pl/quickstart.md): Set up your internal network access and make your first Flux Metadata Service calls to wrap a DEK, create a metadata record, and retrieve it.

## Optional

- [FluxDrop](https://fluxdrop.eu)