# Node

Operations for managing flow nodes (endpoints)

## endpointCreate

> 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.&#x20;

```json
{"openapi":"3.1.0","info":{"title":"Navixy IoT Logic API","version":"1.0.0"},"tags":[{"name":"Node","description":"Operations for managing flow nodes (endpoints)"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\"","name":"Authorization","in":"header"}},"schemas":{"IotEndpointDraft":{"type":"object","description":"Input or output endpoint draft (for creation)","properties":{"user_id":{"type":"integer","description":"Master user ID"},"type":{"type":"string","description":"Endpoint type. One of: 'input_default', 'output_default', 'output_mqtt_client'."},"title":{"type":"string"},"status":{"type":"string","description":"Endpoint status. One of: 'active', 'suspend', 'disabled'."},"properties":{"type":"object","oneOf":[{"$ref":"#/components/schemas/IotEndpointMqttClientProperties"},{"type":"object","description":"Navixy endpoint - empty object (no properties)","properties":{}}]}},"required":["type","title","status"]},"IotEndpointMqttClientProperties":{"type":"object","description":"MQTT client endpoint","properties":{"protocol":{"type":"string","description":"Protocol of messages: \"NGP\" (Navixy Generic Protocol)"},"domain":{"type":"string","description":"MQTT domain or IP address"},"port":{"type":"integer","description":"MQTT port"},"client_id":{"type":"string","description":"MQTT client ID"},"qos":{"type":"integer","description":"MQTT QoS: 0 or 1 (2 is unsupported at the moment)"},"topics":{"type":"array","items":{"type":"string","description":"MQTT topic name"}},"version":{"type":"string","description":"MQTT version: \"3.1.1\" or \"5.0\""},"use_ssl":{"type":"boolean","description":"Use or not SSL encryption for MQTT connection"},"mqtt_auth":{"type":"boolean","description":"Use or not MQTT authentication"},"user_name":{"type":"string","description":"MQTT user name"},"user_password":{"type":"string","description":"MQTT password"}},"required":["protocol","domain","port","client_id","qos","topics","version","use_ssl","mqtt_auth"]}},"responses":{"EntityCreatedResponse":{"description":"Successful creation response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully","readOnly":true},"id":{"type":"integer","description":"ID of the created entity","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. It only presence when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}}}}}}}}},"paths":{"/iot/logic/flow/endpoint/create":{"post":{"tags":["Node"],"summary":"endpointCreate","description":"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. ","operationId":"endpointCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"$ref":"#/components/schemas/IotEndpointDraft"}},"required":["endpoint"]}}}},"responses":{"200":{"$ref":"#/components/responses/EntityCreatedResponse"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

## endpointRead

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Navixy IoT Logic API","version":"1.0.0"},"tags":[{"name":"Node","description":"Operations for managing flow nodes (endpoints)"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\"","name":"Authorization","in":"header"}},"schemas":{"IotEndpoint":{"type":"object","description":"Input or output endpoint","allOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Endpoint ID inside user account","readOnly":true}},"required":["id"]},{"$ref":"#/components/schemas/IotEndpointDraft"}]},"IotEndpointDraft":{"type":"object","description":"Input or output endpoint draft (for creation)","properties":{"user_id":{"type":"integer","description":"Master user ID"},"type":{"type":"string","description":"Endpoint type. One of: 'input_default', 'output_default', 'output_mqtt_client'."},"title":{"type":"string"},"status":{"type":"string","description":"Endpoint status. One of: 'active', 'suspend', 'disabled'."},"properties":{"type":"object","oneOf":[{"$ref":"#/components/schemas/IotEndpointMqttClientProperties"},{"type":"object","description":"Navixy endpoint - empty object (no properties)","properties":{}}]}},"required":["type","title","status"]},"IotEndpointMqttClientProperties":{"type":"object","description":"MQTT client endpoint","properties":{"protocol":{"type":"string","description":"Protocol of messages: \"NGP\" (Navixy Generic Protocol)"},"domain":{"type":"string","description":"MQTT domain or IP address"},"port":{"type":"integer","description":"MQTT port"},"client_id":{"type":"string","description":"MQTT client ID"},"qos":{"type":"integer","description":"MQTT QoS: 0 or 1 (2 is unsupported at the moment)"},"topics":{"type":"array","items":{"type":"string","description":"MQTT topic name"}},"version":{"type":"string","description":"MQTT version: \"3.1.1\" or \"5.0\""},"use_ssl":{"type":"boolean","description":"Use or not SSL encryption for MQTT connection"},"mqtt_auth":{"type":"boolean","description":"Use or not MQTT authentication"},"user_name":{"type":"string","description":"MQTT user name"},"user_password":{"type":"string","description":"MQTT password"}},"required":["protocol","domain","port","client_id","qos","topics","version","use_ssl","mqtt_auth"]}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. It only presence when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}}}}}}}}},"paths":{"/iot/logic/flow/endpoint/read":{"post":{"tags":["Node"],"summary":"endpointRead","description":"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.","operationId":"endpointRead","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint_id":{"type":"integer","description":"Endpoint ID in database"}},"required":["endpoint_id"]}}}},"responses":{"200":{"description":"Successful response to read endpoint","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully","readOnly":true},"value":{"$ref":"#/components/schemas/IotEndpoint"}}}}}},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

## endpointUpdate

> 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.&#x20;

```json
{"openapi":"3.1.0","info":{"title":"Navixy IoT Logic API","version":"1.0.0"},"tags":[{"name":"Node","description":"Operations for managing flow nodes (endpoints)"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\"","name":"Authorization","in":"header"}},"schemas":{"IotEndpoint":{"type":"object","description":"Input or output endpoint","allOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Endpoint ID inside user account","readOnly":true}},"required":["id"]},{"$ref":"#/components/schemas/IotEndpointDraft"}]},"IotEndpointDraft":{"type":"object","description":"Input or output endpoint draft (for creation)","properties":{"user_id":{"type":"integer","description":"Master user ID"},"type":{"type":"string","description":"Endpoint type. One of: 'input_default', 'output_default', 'output_mqtt_client'."},"title":{"type":"string"},"status":{"type":"string","description":"Endpoint status. One of: 'active', 'suspend', 'disabled'."},"properties":{"type":"object","oneOf":[{"$ref":"#/components/schemas/IotEndpointMqttClientProperties"},{"type":"object","description":"Navixy endpoint - empty object (no properties)","properties":{}}]}},"required":["type","title","status"]},"IotEndpointMqttClientProperties":{"type":"object","description":"MQTT client endpoint","properties":{"protocol":{"type":"string","description":"Protocol of messages: \"NGP\" (Navixy Generic Protocol)"},"domain":{"type":"string","description":"MQTT domain or IP address"},"port":{"type":"integer","description":"MQTT port"},"client_id":{"type":"string","description":"MQTT client ID"},"qos":{"type":"integer","description":"MQTT QoS: 0 or 1 (2 is unsupported at the moment)"},"topics":{"type":"array","items":{"type":"string","description":"MQTT topic name"}},"version":{"type":"string","description":"MQTT version: \"3.1.1\" or \"5.0\""},"use_ssl":{"type":"boolean","description":"Use or not SSL encryption for MQTT connection"},"mqtt_auth":{"type":"boolean","description":"Use or not MQTT authentication"},"user_name":{"type":"string","description":"MQTT user name"},"user_password":{"type":"string","description":"MQTT password"}},"required":["protocol","domain","port","client_id","qos","topics","version","use_ssl","mqtt_auth"]}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. It only presence when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}}}}}}}}},"paths":{"/iot/logic/flow/endpoint/update":{"post":{"tags":["Node"],"summary":"endpointUpdate","description":"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. ","operationId":"endpointUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"$ref":"#/components/schemas/IotEndpoint"}},"required":["endpoint"]}}}},"responses":{"200":{"$ref":"#/components/responses/OK"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

## endpointDelete

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Navixy IoT Logic API","version":"1.0.0"},"tags":[{"name":"Node","description":"Operations for managing flow nodes (endpoints)"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\"","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. It only presence when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}}}}}}}}},"paths":{"/iot/logic/flow/endpoint/delete":{"post":{"tags":["Node"],"summary":"endpointDelete","description":"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.","operationId":"endpointDelete","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint_id":{"type":"integer","description":"Endpoint ID in database"}},"required":["endpoint_id"]}}}},"responses":{"200":{"$ref":"#/components/responses/OK"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

## endpointList

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Navixy IoT Logic API","version":"1.0.0"},"tags":[{"name":"Node","description":"Operations for managing flow nodes (endpoints)"}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter an API key with the \"NVX: \" prefix, e.g. \"NVX 123456abcdefg\"","name":"Authorization","in":"header"}},"schemas":{"IotEndpoint":{"type":"object","description":"Input or output endpoint","allOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Endpoint ID inside user account","readOnly":true}},"required":["id"]},{"$ref":"#/components/schemas/IotEndpointDraft"}]},"IotEndpointDraft":{"type":"object","description":"Input or output endpoint draft (for creation)","properties":{"user_id":{"type":"integer","description":"Master user ID"},"type":{"type":"string","description":"Endpoint type. One of: 'input_default', 'output_default', 'output_mqtt_client'."},"title":{"type":"string"},"status":{"type":"string","description":"Endpoint status. One of: 'active', 'suspend', 'disabled'."},"properties":{"type":"object","oneOf":[{"$ref":"#/components/schemas/IotEndpointMqttClientProperties"},{"type":"object","description":"Navixy endpoint - empty object (no properties)","properties":{}}]}},"required":["type","title","status"]},"IotEndpointMqttClientProperties":{"type":"object","description":"MQTT client endpoint","properties":{"protocol":{"type":"string","description":"Protocol of messages: \"NGP\" (Navixy Generic Protocol)"},"domain":{"type":"string","description":"MQTT domain or IP address"},"port":{"type":"integer","description":"MQTT port"},"client_id":{"type":"string","description":"MQTT client ID"},"qos":{"type":"integer","description":"MQTT QoS: 0 or 1 (2 is unsupported at the moment)"},"topics":{"type":"array","items":{"type":"string","description":"MQTT topic name"}},"version":{"type":"string","description":"MQTT version: \"3.1.1\" or \"5.0\""},"use_ssl":{"type":"boolean","description":"Use or not SSL encryption for MQTT connection"},"mqtt_auth":{"type":"boolean","description":"Use or not MQTT authentication"},"user_name":{"type":"string","description":"MQTT user name"},"user_password":{"type":"string","description":"MQTT password"}},"required":["protocol","domain","port","client_id","qos","topics","version","use_ssl","mqtt_auth"]}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. It only presence when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}}}}}}}}},"paths":{"/iot/logic/flow/endpoint/list":{"post":{"tags":["Node"],"summary":"endpointList","description":"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.","operationId":"endpointList","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful response to read a list of endpoints","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully","readOnly":true},"list":{"type":"array","description":"List of user's endpoints","readOnly":true,"items":{"$ref":"#/components/schemas/IotEndpoint"}}}}}}},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```
