Fetch network nodes

GET 
/api/v1/networks/:networkId/nodes

This API endpoint retrieve a list of network nodes within the network identified by the provided networkId. This includes details about each node and its associated network, machine information.

Request

Path Parameters

networkId stringrequired

The networkId - unique id of the network

Query Parameters

allParams objectrequired

allParams - pageNo, pageSize, sortBy, sortDirection, etc.

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]

payload

object

Schema for paginated response

content

object[]

Array [

nodeId string

ipv4Address string

ipv6Address string

networkId string

createdAt date-time

networks

object

Networks schema

networkId string

provider string

ipSubnet string

networkName string

isDefault boolean

isNetworkKeyManaged boolean

machineData

object

Schema for machine data in network node response

machineId string

displayIconMediaPath string

alias string

name string

lastActiveAt date-time

]

totalPages int32

totalRecordCount int64

pageSize int32

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "nodeId": "string",
        "ipv4Address": "string",
        "ipv6Address": "string",
        "networkId": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "networks": {
          "networkId": "string",
          "provider": "string",
          "ipSubnet": "string",
          "networkName": "string",
          "isDefault": true,
          "isNetworkKeyManaged": true
        },
        "machineData": {
          "machineId": "string",
          "displayIconMediaPath": "string",
          "alias": "string",
          "name": "string",
          "lastActiveAt": "2024-07-29T15:51:28.071Z"
        }
      }
    ],
    "totalPages": 0,
    "totalRecordCount": 0,
    "pageSize": 0
  }
}

Network nodes list example

Network nodes list response example

{
  "success": true,
  "message": "Network nodes fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "nodeId": "f32552de-903f-48a0-bb2d-4b39b016b3ef",
        "ipv4Address": "100.64.0.1",
        "ipv6Address": "string",
        "networkId": "xxb63e2aaedx-pffc-123",
        "createdAt": "2024-06-17T08:01:52.134Z",
        "networks": {
          "networkId": "xxb63e2aaedx-pffc-123",
          "provider": "provider",
          "ipSubnet": "10.0.0.0/24",
          "networkName": "test",
          "isDefault": true,
          "isNetworkKeyManaged": true
        },
        "machineData": {
          "machineId": "xxb63e2aaedx-xxxx-123",
          "displayIconMediaPath": "string",
          "alias": "test-alias",
          "name": "Test machine",
          "lastActiveAt": "2024-06-06T05:42:20.278Z"
        }
      }
    ],
    "totalPages": 2,
    "totalRecordCount": 2,
    "pageSize": 1
  }
}

Loading...