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

successbooleanRead-onlyOptional

true if request finished successfully

Example: true

idintegerRead-onlyOptional

ID of the created entity

Example: 1723

default

Error response object

application/json

post

/iot/logic/flow/create

POST /v2/iot/logic/flow/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "flow": {
    "title": "Super flow",
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

{
  "success": true,
  "id": 1723
}

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

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

get

/iot/logic/flow/read

GET /v2/iot/logic/flow/read?flow_id=12 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {
    "id": 543,
    "title": "Super flow",
    "description": null,
    "enabled": true,
    "default_flow": false,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

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

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

default

Error response object

application/json

post

/iot/logic/flow/update

POST /v2/iot/logic/flow/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "flow": {
    "title": "Super flow",
    "enabled": true,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

{
  "success": true
}

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

successbooleanRead-onlyOptional

true if request finished successfully, otherwise false

Example: true

default

Error response object

application/json

post

/iot/logic/flow/delete

POST /v2/iot/logic/flow/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "flow_id": 12
}

{
  "success": true
}

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

successbooleanRead-onlyOptional

true if request finished successfully

Example: true

default

Error response object

application/json

get

/iot/logic/flow/list

GET /v2/iot/logic/flow/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "id": 1234,
      "title": "Super flow"
    }
  ]
}

flowExport

get

/iot/logic/flow/export

Export a flow as a reusable template without instance-specific metadata. Unlike the read endpoint which retrieves the complete operational state of a flow, export returns only the flow structure (nodes, edges, title, description) suitable for creating duplicate flows or transferring configurations between accounts. The exported template excludes flow ID, enabled status, and default flow designation, making it ready for use with the create endpoint.

Authorizations

AuthorizationstringRequired

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

Query parameters

flow_idintegerRequired

Flow ID to export

Example: 678

Responses

200

Successful response

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

default

Error response object

application/json

get

/iot/logic/flow/export

GET /v2/iot/logic/flow/export?flow_id=678 HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": {
    "title": "text",
    "description": null,
    "nodes": [
      {
        "id": 1,
        "type": "data_source",
        "data": {
          "title": "Standard Data Source",
          "source_ids": [
            123458,
            123459
          ]
        },
        "view": {
          "position": {
            "x": 25,
            "y": 25
          }
        }
      }
    ],
    "edges": [
      {
        "from": 1,
        "to": 2,
        "type": "simple_edge"
      }
    ]
  }
}

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

anyOptionalExample:

{"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}

default

Error response object

application/json

get

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

GET /v2/iot/logic/flow/sources/mapping/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "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
}

PreviousAPI reference NextNode

Last updated 5 days ago

Was this helpful?

hashtagflowCreate

hashtagflowRead

hashtagflowUpdate

hashtagflowDelete

hashtagflowList

hashtagflowExport

hashtagsourceMappingList

flowCreate

flowRead

flowUpdate

flowDelete

flowList

flowExport

sourceMappingList