Infrastructure Interface
API Reference
Deploy, manage, and scale your FluxPort resources programmatically via our unified REST API.
Authentication
Every request to the FluxPort API must be authenticated using a Bearer Token or a valid X-API-Key header.
Tokens can be generated within your FluxPort dashboard settings and are scoped to either your account or a specific workspace.
# Request Header Sample Authorization: Bearer <your_jwt_token> X-API-Key: <your_workspace_key> X-Workspace-Id: <id>
Endpoints Explorer
GET
/v1/workspacesList all workspaces the authenticated user has access to.
JWT Required
POST
/v1/saved-requestsCreate a new saved request entry within a collection.
JWT Required
GET
/v1/collections/:idRetrieve a complete collection tree including folders and requests.
JWT Required
POST
/relay/auth-proxyIntercept and relay a request through the Smart Proxy engine.
API Key Required
Code Sandbox
Direct Integration
Copy these snippets to integrate FluxPort automation directly into your environment setup scripts.
cURL request
curl -X POST "https://gateway.fluxport.io/v1/collections" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "name": "Production APIs" }' Axios (Node.js)
const axios = require('axios');
axios.get('https://gateway.fluxport.io/v1/workspaces', {
headers: { 'Authorization': 'Bearer <token>' }
}).then(res => console.log(res.data));