Flow

Operations for managing data flows

flowCreate

post
/iot/logic/flow/create

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.

Authorizations
AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body
Responses
200

Successful creation response

application/json
post
/iot/logic/flow/create

flowRead

get
/iot/logic/flow/read

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.

Authorizations
AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Query parameters
flow_idintegerRequired

Flow ID

Example: 12
Responses
200

Successful response to read a flow

application/json
get
/iot/logic/flow/read

flowUpdate

post
/iot/logic/flow/update

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.

Authorizations
AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body
flowall ofRequired

Flowchart object

Responses
200

Successful response

application/json
post
/iot/logic/flow/update

flowDelete

post
/iot/logic/flow/delete

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.

Authorizations
AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Body
flow_idintegerRequired

Flow ID

Example: 12
Responses
200

Successful response to delete a flow

application/json
post
/iot/logic/flow/delete

flowList

get
/iot/logic/flow/list

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.

Authorizations
AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Responses
200

Successful response to read a list of flows

application/json
get
/iot/logic/flow/list

sourceMappingList

get
/iot/logic/flow/sources/mapping/list

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.

Authorizations
AuthorizationstringRequired

Enter an API key with the "NVX: " prefix, e.g. "NVX 123456abcdefg"

Query parameters
offsetintegerOptionalDefault: 0
limitinteger · min: 1 · max: 100000OptionalDefault: 10000
Responses
200

success

application/json
ResponseanyExample: {"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}
get
/iot/logic/flow/sources/mapping/list

Last updated

Was this helpful?