Node

Operations for managing flow nodes (endpoints)

endpointCreate

post

/iot/logic/flow/endpoint/create

Create a new node within a flow. Supports all node types existing in IoT Logic. The node type is specified in the request body's type field.

Authorizations

AuthorizationstringRequired

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

Body

Responses

200

Successful creation response

application/json

default

Error response object

application/json

post

/iot/logic/flow/endpoint/create

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

{
  "endpoint": {
    "user_id": 8,
    "type": "output_mqtt_client",
    "title": "MQTT Endpoint Client Properties",
    "status": "text",
    "properties": {
      "protocol": "NGP",
      "domain": "127.0.0.1",
      "port": 1883,
      "client_id": "Navixy (panel #123)",
      "qos": 1,
      "topics": [
        "iot/navixy"
      ],
      "version": "5.0",
      "use_ssl": false,
      "mqtt_auth": true,
      "user_name": "navixy",
      "user_password": "your_super_strong_password"
    }
  }
}

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

endpointRead

post

/iot/logic/flow/endpoint/read

Retrieve detailed configuration for a specific node. Returns complete node data including type-specific configuration, position, and enabled status. Use this endpoint to inspect individual node configuration without retrieving the entire flow.

Authorizations

AuthorizationstringRequired

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

Body

endpoint_idintegerRequired

Endpoint ID in database

Example: 1723

Responses

200

Successful response to read endpoint

application/json

default

Error response object

application/json

post

/iot/logic/flow/endpoint/read

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

{
  "endpoint_id": 1723
}

{
  "success": true,
  "value": {
    "id": 12345,
    "user_id": 8,
    "type": "output_mqtt_client",
    "title": "MQTT Endpoint Client Properties",
    "status": "text",
    "properties": {
      "protocol": "NGP",
      "domain": "127.0.0.1",
      "port": 1883,
      "client_id": "Navixy (panel #123)",
      "qos": 1,
      "topics": [
        "iot/navixy"
      ],
      "version": "5.0",
      "use_ssl": false,
      "mqtt_auth": true,
      "user_name": "navixy",
      "user_password": "your_super_strong_password"
    }
  }
}

endpointUpdate

post

/iot/logic/flow/endpoint/update

Update an existing node configuration. Requires the complete node object including all required fields for the node type. Changes to nodes in enabled flows take effect immediately and may impact active data processing.

Authorizations

AuthorizationstringRequired

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

Body

endpointall ofRequired

Input or output endpoint

Responses

200

Successful response

application/json

default

Error response object

application/json

post

/iot/logic/flow/endpoint/update

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

{
  "endpoint": {
    "user_id": 8,
    "type": "output_mqtt_client",
    "title": "MQTT Endpoint Client Properties",
    "status": "text",
    "properties": {
      "protocol": "NGP",
      "domain": "127.0.0.1",
      "port": 1883,
      "client_id": "Navixy (panel #123)",
      "qos": 1,
      "topics": [
        "iot/navixy"
      ],
      "version": "5.0",
      "use_ssl": false,
      "mqtt_auth": true,
      "user_name": "navixy",
      "user_password": "your_super_strong_password"
    }
  }
}

{
  "success": true
}

endpointDelete

post

/iot/logic/flow/endpoint/delete

Permanently delete a node from accoun. Automatically removes all edges connected to this node. Deleting critical nodes (Data Source or Output Endpoint) from enabled flows will interrupt data processing. Verify flow integrity after deletion.

Authorizations

AuthorizationstringRequired

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

Body

endpoint_idintegerRequired

Endpoint ID in database

Example: 1723

Responses

200

Successful response

application/json

default

Error response object

application/json

post

/iot/logic/flow/endpoint/delete

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

{
  "endpoint_id": 1723
}

{
  "success": true
}

endpointList

post

/iot/logic/flow/endpoint/list

List all nodes across all flows in the user account. Returns complete node configurations including type, data, and position for each node. To retrieve nodes for a specific flow, use the flow read endpoint instead.

Authorizations

AuthorizationstringRequired

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

Body

objectOptional

Responses

200

Successful response to read a list of endpoints

application/json

default

Error response object

application/json

post

/iot/logic/flow/endpoint/list

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

{}

{
  "success": true,
  "list": [
    {
      "id": 12345,
      "user_id": 8,
      "type": "output_mqtt_client",
      "title": "MQTT Endpoint Client Properties",
      "status": "text",
      "properties": {
        "protocol": "NGP",
        "domain": "127.0.0.1",
        "port": 1883,
        "client_id": "Navixy (panel #123)",
        "qos": 1,
        "topics": [
          "iot/navixy"
        ],
        "version": "5.0",
        "use_ssl": false,
        "mqtt_auth": true,
        "user_name": "navixy",
        "user_password": "your_super_strong_password"
      }
    }
  ]
}

PreviousFlow NextModels

Last updated 1 day ago

Was this helpful?