ContactsLog inGet startedAsk Navixy AI

Node

Operations for managing flow nodes (endpoints)

endpointCreate

post
/iot/logic/flow/endpoint/create

Create a new node.

All node types are created through this endpoint, the type is defined in the request body.

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

Read an existing node details.

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

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

Delete a node.

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

Get list of nodes existing in a user account.

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
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"
      }
    }
  ]
}
PreviousFlowNextModels

Last updated

Was this helpful?