OK
Flux Decentralized Cloud API (6.6.1)
Welcome to the comprehensive API reference for Flux, the world's leading decentralized Web3 cloud computing platform. This documentation covers all available API endpoints for interacting with the Flux network, nodes, and decentralized applications.
Flux is a decentralized Web3 cloud infrastructure powered by globally distributed, user-operated nodes. Built for scalability and censorship resistance, Flux eliminates single points of failure while providing enterprise-grade computing resources for deploying and managing applications.
- 🌐 Decentralized Infrastructure: Over 15,000 nodes worldwide providing 111,500+ cores, 193TB+ RAM, and 6.7PB+ SSD storage - ⚡ High Performance: Enterprise-grade computing with automatic load balancing and high availability - 🔐 Secure by Design: Multiple authentication methods with advanced cryptographic security - 💰 Cost Effective: Competitive pricing compared to traditional cloud providers - 🚀 Developer Friendly: Docker-based deployments with comprehensive API support
The Flux API uses a 5-tier permission hierarchy to ensure secure and controlled access: | Permission Level | Description | Authentication Required | |------------------|-------------|-------------------------| | Public | Open access endpoints | ❌ No | | User | User-level permissions | ✅ Yes | | FluxTeam | Flux Team member access | ✅ Yes | | Admin | Node administrator access | ✅ Yes | | AdminAndFluxTeam | Combined Admin & FluxTeam access | ✅ Yes | | AppOwner | Application owner permissions | ✅ Yes | | AppOwnerAbove | App Owner, FluxTeam, and Admin access | ✅ Yes |
- GET: Most endpoints support GET requests with parameters as query strings or path variables - POST: Used for endpoints requiring large payloads or sensitive data - WebSocket: Used for real-time communication and simplified authentication flows
Flux supports multiple modern authentication methods for maximum flexibility and security:
Secure, Simple, Powerful - The next-generation 2FA wallet with enterprise security:
- True 2-of-2 Multi-Signature: Requires both browser extension and mobile app authorization - Advanced Security: BIP48 derivation, Account Abstraction (ERC-4337), Schnorr signatures - Multi-Chain Support: Bitcoin, Ethereum, Polygon, BSC, Avalanche, and 15+ blockchains - WalletConnect v2: Connect to thousands of dApps seamlessly - Professional Audit: Thoroughly audited by security experts in 2025 Installation: - Chrome Extension: SSP Wallet - Chrome Web Store - Mobile App: Available on iOS App Store and Google Play Store - Website: sspwallet.io
Multi-Asset Cryptocurrency Wallet - The original Flux ecosystem wallet:
- Self-Custodial: Full control over your private keys - Decentralized 2FA (d2FA): Unique blockchain-based two-factor authentication - Multi-Chain: Support for 80+ blockchains and thousands of assets - Hardware Integration: Connect with hardware wallets for enhanced security - Deep Linking: Native
zel:
protocol support Installation: zelcore.io
Ethereum Ecosystem Wallet - Popular browser extension wallet:
- Ethereum Native: Full Ethereum and EVM chain support - Sign-In with Ethereum (SIWE): ERC-4361 standard compliance - Wide Adoption: Most popular Web3 wallet with extensive dApp support - Domain Binding: Advanced phishing protection Installation: metamask.io
Universal Wallet Connection Protocol - Connect any compatible wallet:
- 700+ Wallets: Support for hundreds of popular wallets - Cross-Platform: Mobile, desktop, and web wallet compatibility - Secure Bridge: Encrypted communication between wallet and dApp - QR Code Connection: Simple mobile wallet connection
Email-Based Login - For users preferring traditional authentication:
- Firebase Integration: Google Firebase authentication backend - Email/Password: Standard username/password login - Google OAuth: Sign in with Google account - Account Recovery: Standard password reset flows
Select from the supported wallet options above based on your development needs and user preferences. All methods are supported by the FluxOS API.
Install and configure your chosen wallet: - Download from official sources only - Secure your seed phrase or recovery information - Enable two-factor authentication where available - Test with small amounts first
Follow the Authentication section in this API documentation to: - Generate login phrases - Sign authentication messages - Obtain session tokens - Set up API headers
For authenticated requests, include these headers:
"zelid": "your-wallet-address",
"signature": "signed-message-signature",
"loginPhrase": "temporary-login-phrase"
} ```
**Note**: Signature values may need to be URL-encoded depending on your HTTP client.
### 5. Start Making API Calls
Test your setup with public endpoints first, then proceed to authenticated endpoints once your credentials are properly configured.
## Support & Community
- **Documentation**: [docs.runonflux.com](https://docs.runonflux.com) - **Discord Community**: [discord.io/runonflux](https://discord.io/runonflux) - **GitHub**: [github.com/RunOnFlux](https://github.com/RunOnFlux) - **Twitter/X**: [@RunOnFlux](https://x.com/runonflux) - **Website**: [runonflux.com](https://runonflux.com)
**🚀 Ready to build on the decentralized web? Let's get started!**
## Important Notes
- Login phrases expire after 15 minutes - Session tokens are valid for up to 14 days - Always use HTTPS in production environments - Signature values may need URL encoding depending on your HTTP client
## Authentication Workflows
### 🔐 Complete Authentication Flow
**Step 1: Get Login Phrase** ```bash curl -X GET "https://api.runonflux.io/id/loginphrase" ```
**Step 2: Sign the Login Phrase** - **SSP Wallet**: Use browser extension + mobile app to sign the message - **ZelCore**: Use the wallet's message signing feature - **MetaMask**: Use `personal_sign` method - **Hardware Wallet**: Sign via hardware device integration
**Step 3: Verify Login** ```bash curl -X POST "https://api.runonflux.io/id/verifylogin" \
-H "Content-Type: application/json" \
-d '{
"zelid": "your-wallet-address",
"loginPhrase": "phrase-from-step-1",
"signature": "your-signature-from-step-2"
}'
Step 4: Use Authentication Header ```bash curl -X GET "https://api.runonflux.io/id/loggedsessions"
-H "zelidauth: zelid=your-address&signature=your-signature&loginPhrase=your-phrase"
### 📱 SSP Wallet Integration Guide
**Browser Extension Setup:** 1. Install SSP Wallet Chrome Extension 2. Install SSP Key mobile app (iOS/Android) 3. Pair devices using QR code 4. Fund wallet with small amount for testing
**Signing Messages with SSP:** ```javascript // Connect to SSP Wallet if (window.ssp) {
const accounts = await window.ssp.request({
method: 'wallet_requestPermissions',
params: [{ wallet_accounts: {} }]
});
// Sign login phrase
const signature = await window.ssp.request({
method: 'personal_sign',
params: [loginPhrase, accounts[0]]
});
} ```
### 🦊 MetaMask Integration Guide
**Connect and Sign:** ```javascript // Connect MetaMask const accounts = await ethereum.request({
method: 'eth_requestAccounts'
});
// Sign login phrase const signature = await ethereum.request({
method: 'personal_sign',
params: [loginPhrase, accounts[0]]
});
// Use Ethereum address as zelid const zelid = accounts[0]; ```
### 🔑 ZelCore Wallet Integration
**Deep Link Integration:** ```javascript // Generate ZelCore deep link for signing const zelcoreUrl = `zel:?action=sign&message=${encodeURIComponent(loginPhrase)}&icon=https://yourapp.com/icon.png&callback=${encodeURIComponent('https://yourapp.com/auth/callback')}`;
// Open ZelCore for signing window.location.href = zelcoreUrl; ```
**WebSocket Integration:** ```javascript // Listen for ZelCore signature via WebSocket const ws = new WebSocket(`wss://api.runonflux.io/ws/id/${loginPhrase}`);
ws.onmessage = (event) => {
const authData = JSON.parse(event.data);
if (authData.status === 'success') {
// Authentication successful
console.log('Signed in with ZelID:', authData.data.zelid);
}
}; ```
### 🔗 WalletConnect v2 Integration
**Setup WalletConnect:** ```javascript import { SignClient } from '@walletconnect/sign-client';
const signClient = await SignClient.init({
projectId: 'your-walletconnect-project-id',
metadata: {
name: 'Your Flux App',
description: 'Flux Network Integration',
url: 'https://yourapp.com',
icons: ['https://yourapp.com/logo.png']
}
});
// Connect to wallet const { uri, approval } = await signClient.connect({
requiredNamespaces: {
eip155: {
methods: ['personal_sign'],
chains: ['eip155:1'],
events: ['chainChanged', 'accountsChanged']
}
}
});
// Sign message when connected const signature = await signClient.request({
topic: session.topic,
chainId: 'eip155:1',
request: {
method: 'personal_sign',
params: [loginPhrase, address]
}
}); ```
### 📧 Traditional Email Authentication
**Firebase Integration:** ```javascript import { getAuth, signInWithEmailAndPassword } from 'firebase/auth';
// Email/password login const auth = getAuth(); const userCredential = await signInWithEmailAndPassword(auth, email, password);
// Get ID token for API authentication const idToken = await userCredential.user.getIdToken();
// Use token in API calls fetch('https://api.runonflux.io/protected-endpoint', {
headers: {
'Authorization': `Bearer ${idToken}`,
'Content-Type': 'application/json'
}
}); ```
### ⚠️ Common Integration Issues
**Login Phrase Expiration:** ```javascript // Always check phrase timestamp const phraseTimestamp = parseInt(loginPhrase.substring(0, 13)); const now = Date.now(); const age = now - phraseTimestamp;
if (age > 15 * 60 * 1000) { // 15 minutes
throw new Error('Login phrase expired, get a new one');
} ```
**Signature URL Encoding:** ```javascript // Always URL encode signatures for headers const encodedSignature = encodeURIComponent(signature); const authHeader = `zelid=${zelid}&signature=${encodedSignature}&loginPhrase=${loginPhrase}`; ```
**Error Handling:** ```javascript try {
const response = await fetch('/api/authenticated-endpoint', {
headers: { 'zelidauth': authHeader }
});
if (response.status === 401) {
// Re-authenticate user
redirectToLogin();
}
} catch (error) {
console.error('API call failed:', error);
} ```
## API Version Information
**Current Version**: 6.6.1
**Version Notes**: - All endpoints documented in this specification are available in version 6.6.1 - This documentation reflects the current stable API implementation - For the latest changes and updates, refer to the [Flux GitHub repository](https://github.com/runonflux/flux)
https://docs.runonflux.io/_mock/fluxapi/
https://api.runonflux.io/
https://api.runonflux.com/
https://testnet-api.runonflux.io/
https://{nodeip}:16127/
http://localhost:16127/
https://explorer.runonflux.io/
https://stats.runonflux.io/
Authentication
Authentication & Authorization Endpoints Essential API endpoints for secure authentication and authorization with the Flux network. These endpoints handle login phrase generation, message signing verification, and session management for all supported wallet types including SSP Wallet, ZelCore, MetaMask, and WalletConnect integrations. Key Features: - Multi-wallet authentication support - Secure login phrase generation - Cryptographic signature verification - Session token management - 5-tier permission system integration
ID
Identity & User Management Comprehensive identity management endpoints that handle user authentication, authorization levels, and identity verification across multiple blockchain addresses (Bitcoin P2PKH, Ethereum, ZelID). These endpoints manage user sessions, permissions, and access control throughout the Flux ecosystem. Supported Address Types: - Bitcoin P2PKH addresses - Ethereum addresses - ZelID addresses - Multi-signature addresses
Daemon
Flux Daemon Operations Core blockchain daemon endpoints for interacting with the underlying Flux blockchain node. These endpoints provide access to blockchain data, wallet operations, mining information, network statistics, and node management functions. Essential for node operators and developers building blockchain-integrated applications. Core Functions: - Blockchain state queries - Transaction management - Wallet operations - Network information - Mining and staking operations
- Mock server
https://docs.runonflux.io/_mock/fluxapi/daemon/stop
- Production API Gateway - Global load-balanced endpoint
https://api.runonflux.io/daemon/stop
- Backup Production API Gateway
https://api.runonflux.com/daemon/stop
- Testnet API Gateway - For development and testing
https://testnet-api.runonflux.io/daemon/stop
- Direct Flux Node Connection - Connect directly to specific node
https://localhost:16127/daemon/stop
- Local Development Node - For local testing
http://localhost:16127/daemon/stop
- Explorer API - Blockchain data and statistics
https://explorer.runonflux.io/daemon/stop
- Network Statistics API - Real-time network metrics
https://stats.runonflux.io/daemon/stop
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.runonflux.io/_mock/fluxapi/daemon/stop \
-H 'zelidauth: YOUR_API_KEY_HERE'
{ "status": "success", "data": "Stop Flux server" }
- Mock server
https://docs.runonflux.io/_mock/fluxapi/daemon/createfluxnodekey
- Production API Gateway - Global load-balanced endpoint
https://api.runonflux.io/daemon/createfluxnodekey
- Backup Production API Gateway
https://api.runonflux.com/daemon/createfluxnodekey
- Testnet API Gateway - For development and testing
https://testnet-api.runonflux.io/daemon/createfluxnodekey
- Direct Flux Node Connection - Connect directly to specific node
https://localhost:16127/daemon/createfluxnodekey
- Local Development Node - For local testing
http://localhost:16127/daemon/createfluxnodekey
- Explorer API - Blockchain data and statistics
https://explorer.runonflux.io/daemon/createfluxnodekey
- Network Statistics API - Real-time network metrics
https://stats.runonflux.io/daemon/createfluxnodekey
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.runonflux.io/_mock/fluxapi/daemon/createfluxnodekey \
-H 'zelidauth: YOUR_API_KEY_HERE'
{ "status": "success", "data": "5JwVKe7UH986ncSL2jG9KdUY2AuZUTDAkTsp4TZoGWdD5cLLiFR" }
- Mock server
https://docs.runonflux.io/_mock/fluxapi/daemon/listfluxnodeconf
- Production API Gateway - Global load-balanced endpoint
https://api.runonflux.io/daemon/listfluxnodeconf
- Backup Production API Gateway
https://api.runonflux.com/daemon/listfluxnodeconf
- Testnet API Gateway - For development and testing
https://testnet-api.runonflux.io/daemon/listfluxnodeconf
- Direct Flux Node Connection - Connect directly to specific node
https://localhost:16127/daemon/listfluxnodeconf
- Local Development Node - For local testing
http://localhost:16127/daemon/listfluxnodeconf
- Explorer API - Blockchain data and statistics
https://explorer.runonflux.io/daemon/listfluxnodeconf
- Network Statistics API - Real-time network metrics
https://stats.runonflux.io/daemon/listfluxnodeconf
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.runonflux.io/_mock/fluxapi/daemon/listfluxnodeconf \
-H 'zelidauth: YOUR_API_KEY_HERE'
{ "status": "success", "data": [ { … } ] }
Benchmark
Node Performance & Benchmarking Endpoints for monitoring and managing Flux node performance benchmarks. These APIs provide access to hardware specifications, performance metrics, benchmark results, and node tier qualification status. Critical for node operators to ensure optimal performance and maintain network participation requirements. Monitoring Capabilities: - Hardware specification reporting - Performance benchmark execution - Node tier status verification - Resource utilization metrics - Network connectivity testing
Flux
Flux Network Operations Core network endpoints for interacting with the broader Flux decentralized network. These APIs provide access to network statistics, node information, consensus data, and network-wide operations that facilitate the decentralized cloud infrastructure. Network Services: - Node discovery and registry - Network consensus information - Global network statistics - Peer-to-peer communication - Distributed coordination
Apps
Decentralized Application Management Comprehensive endpoints for deploying, managing, and monitoring decentralized applications (dApps) on the Flux network. These APIs handle the complete application lifecycle from deployment to scaling, including Docker container management, resource allocation, and global distribution across the Flux node network. Application Services: - Docker-based app deployment - Application lifecycle management - Resource scaling and allocation - Multi-region distribution - Application marketplace integration - Performance monitoring and analytics
Explorer
Blockchain Explorer Services Blockchain exploration endpoints providing detailed access to on-chain data, transaction history, address information, and network analytics. These APIs power blockchain explorers and provide developers with comprehensive blockchain data access for building analytics and monitoring applications. Explorer Features: - Transaction history and details - Address balance and activity - Block information and statistics - Network-wide analytics - Search and filtering capabilities
Syncthing
Distributed File Synchronization Endpoints for managing Syncthing-based distributed file synchronization services. These APIs enable secure, decentralized file sharing and synchronization across Flux nodes, providing reliable data distribution and backup capabilities for decentralized applications and user data. Synchronization Services: - Peer-to-peer file synchronization - Distributed storage management - Conflict resolution - Encryption and security - Bandwidth optimization
Backup/Restore
Application Backup & Recovery Comprehensive backup and disaster recovery endpoints for Flux applications and data. These APIs provide automated backup creation, version management, and restoration capabilities to ensure data integrity and business continuity for decentralized applications running on the Flux network. Backup Services: - Automated backup scheduling - Version control and history - Cross-region replication - Point-in-time recovery - Disaster recovery orchestration
Volume Browser
Persistent Storage Management Advanced volume and persistent storage management endpoints for containerized applications. These APIs provide comprehensive file system operations, storage allocation, and data management capabilities for applications requiring persistent data storage across the distributed Flux network. Storage Management: - Volume provisioning and management - File system operations - Storage quota enforcement - Data migration and replication - Performance optimization
IOUtils
File System Operations & Utilities Low-level file system operation endpoints providing essential I/O utilities for application development and system administration. These APIs offer direct file manipulation, directory management, and system utilities required for advanced application deployment and management on Flux nodes. I/O Operations: - File and directory management - Permission and ownership control - Data transfer utilities - System resource monitoring - Batch operation support