Flow
Operations for managing data flows
Create a new data processing flow with nodes and connections. Flows define how data moves from devices through transformation stages to output destinations. Each flow requires at least one Data Source node and one Output Endpoint node. You can create flows with nodes and edges in a single request or add nodes later using the endpoint management API.
Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"
Successful creation response
Error response object
Retrieve complete flow configuration including all nodes, edges, and metadata. Returns the flow structure with node positions, connections, and enabled status. Use this endpoint to inspect flow architecture or retrieve configuration for duplication.
Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"
Flow ID
12Successful response to read a flow
Error response object
Update an existing flow's configuration. Requires the complete flow object including all nodes and edges. To modify individual nodes without affecting the entire flow, use the endpoint management API. Changes take effect immediately for enabled flows.
Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"
Flowchart object
Successful response
Error response object
Permanently delete a flow and stop its data processing pipeline. Devices assigned to this flow will automatically revert to the default flow in your account. This action cannot be undone. To temporarily stop processing without reassigning devices, disable the flow using the update endpoint instead.
Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"
Flow ID
12Successful response to delete a flow
Error response object
List all flows in the user account. Returns flow IDs and titles only. Use the read endpoint to retrieve complete flow details including nodes and configuration.
Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"
Successful response to read a list of flows
Error response object
List all device-to-flow assignments in the user account. Shows which devices are currently assigned to which flows and their corresponding Data Source nodes. Returns device information including title, model, and the flow configuration processing its data. Use this endpoint to audit device assignments, identify unassigned devices, or verify flow coverage across your device fleet. Supports pagination for accounts with large device inventories.
Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"
010000success
{"list":[{"device_title":"Emulator","model_code":"navixy_ngp","device_id":"123456789","flow_id":1,"flow_title":"Default flow","node_id":1,"node_title":"Source node"}],"count":1,"success":true}Error response object
Last updated
Was this helpful?