Node
Operations for managing output endpoints (IotEndpoints) — reusable, account-level output destinations (Navixy platform or external MQTT broker) that are referenced by Output Endpoint nodes inside flows.
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.
Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"
Endpoint for creation. The type field determines the subtype and the required properties.
Successful creation response
true if request finished successfully
trueID of the created entity
1723Bad request. The response body carries the API-level error code in status.code. Common codes are 3 for a wrong hash, 4 for an API key that does not exist or a session that has ended, and 7 for invalid parameters, which adds an errors array naming each parameter at fault. It also returns 230 when the endpoint type is not output_mqtt_client, the only type this operation accepts, because the default endpoint is virtual and never stored.
Payment required, code 268: the account has reached its quota for this entity type.
Access denied, code 13: the session lacks the iot_logic_flow right. Code 101 when the call comes from a demo session, which this operation does not accept.
Error response object
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: 101
{
"endpoint": {
"type": "output_default",
"title": "Navixy Endpoint",
"status": "active",
"description": null
}
}{
"success": true,
"id": 1723
}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.
Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"
Endpoint ID in database
1723Successful response to read endpoint
true if request finished successfully
trueOutput endpoint — full representation. Use the type field to determine which subtype applies.
Bad request. The response body carries the API-level error code in status.code. Common codes are 3 for a wrong hash, 4 for an API key that does not exist or a session that has ended, and 7 for invalid parameters, which adds an errors array naming each parameter at fault. It also returns 201 when the endpoint does not exist.
Access denied, code 13: the session lacks the iot_logic_flow right.
Error response object
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,
"type": "output_default",
"title": "Navixy Endpoint",
"status": "active",
"description": null
}
}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.
Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"
Output endpoint — full representation. Use the type field to determine which subtype applies.
Successful response
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Common codes are 3 for a wrong hash, 4 for an API key that does not exist or a session that has ended, and 7 for invalid parameters, which adds an errors array naming each parameter at fault. It also returns 201 when the endpoint does not exist, and 230 when the endpoint type is not output_mqtt_client, the only type this operation accepts, because the default endpoint is virtual and never stored.
Access denied, code 13: the session lacks the iot_logic_flow right. Code 101 when the call comes from a demo session, which this operation does not accept.
Error response object
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: 101
{
"endpoint": {
"type": "output_default",
"title": "Navixy Endpoint",
"status": "active",
"description": null
}
}{
"success": true
}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.
Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"
Endpoint ID in database
1723Successful response
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Common codes are 3 for a wrong hash, 4 for an API key that does not exist or a session that has ended, and 7 for invalid parameters, which adds an errors array naming each parameter at fault. It also returns 201 when the endpoint does not exist.
Access denied, code 13: the session lacks the iot_logic_flow right. Code 101 when the call comes from a demo session, which this operation does not accept.
Error response object
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
}List all output endpoints in the user account. Returns a summary view for each endpoint: id, title, type, and description. Use endpointRead to retrieve the full configuration including connection properties for a specific endpoint.
Enter an API key with the "NVX " prefix, e.g. "NVX 123456abcdefg"
Successful response to read a list of endpoints
true if request finished successfully
trueBad request. The response body carries the API-level error code in status.code. Common codes are 3 for a wrong hash, 4 for an API key that does not exist or a session that has ended, and 7 for invalid parameters, which adds an errors array naming each parameter at fault.
Access denied, code 13: the session lacks the iot_logic_flow right.
Error response object
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,
"title": "MQTT Endpoint",
"type": "output_mqtt_client",
"description": null
}
]
}Last updated
Was this helpful?