Connecting networks

Prev Next

Use the sections that follow to connect and disconnect Edge Nodes (formerly Edge iNodes) from Cloud Connector (formerly Virtual iNode) networks.

Connect an Edge Node network to a Cloud Connector network

To connect your Edge Node's local network to a Cloud Connector's default network, make the following PUT request with the request body parameters:

 

NameTypeRequired / OptionalDescription

connect_networks

array

Required

Specify your Cloud Connector ID and your Cloud Connector's default network ID.

curl -X PUT \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"connect_networks":[{"node_id":"<your_virtual_inode_id>", \
         "network_id":"<your_virtual_default_network_id>"}]}' \
  'https://<your_company>.manage.iotium.io/api/v1/network/<your_edge_inode_network_id>' \
  | jq .connected_networks

The response includes details of all remote networks connected to this Edge Node network:

[
  {
    "node": {
      "id": "<your_virtual_inode_id>",
      "name": "<your_virtual_inode_name>"
    },
    "network": {
      "id": "<your_virtual_default_network_id>",
      "name": "default"
    },
    "id": "<your_edge_inode_network_id>",
    "connected_at": "2019-09-24T18:19:39.256+05:30"
  }
]

Disconnect an Edge Node network from a Cloud Connector network

To disconnect your Edge Node's local network from the Cloud Connector's default network, make the following PUT request with the request body parameters:

 

NameTypeRequired or OptionalDescription

connect_networks

array

Required

If the Edge Node network is connected to many Cloud Connector networks and you don't want to disconnect all, then specify the connections (remote Cloud Connector ID and remote Cloud Connector default network ID pair) to keep; others will be disconnected.

Specify an empty array to disconnect all remote networks.

curl -X PUT \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"connect_networks":[]}' \
  'https://<your_company>.manage.iotium.io/api/v1/network/<your_edge_inode_network_id>' \
  | jq .connected_networks

The response includes details of all remote networks connected to this Edge Node network; null if no remote networks are connected: