Metrics

Get metrics for all nodes on server

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/metrics

HTTPcURLJavaScriptPython

GET /api/metrics HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "connectivity": {
        "ANY_ADDITIONAL_PROPERTY": {
          "actualuptime": 1,
          "connected": true,
          "lasttotalreceived": 1,
          "lasttotalsent": 1,
          "latency": 1,
          "node_name": "text",
          "percentup": 1,
          "totalreceived": 1,
          "totalsent": 1,
          "totaltime": 1,
          "uptime": 1
        }
      },
      "network": "text",
      "node_id": "text",
      "node_name": "text",
      "updated_at": "text"
    }
  }
}

Get metrics for external clients in a network

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

Responses

200

OK

application/json

networkstringOptional

node_idstringOptional

node_namestringOptional

updated_atstringOptional

500

Internal Server Error

application/json

get

/api/metrics-ext/{network}

HTTPcURLJavaScriptPython

GET /api/metrics-ext/{network} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "connectivity": {
    "ANY_ADDITIONAL_PROPERTY": {
      "actualuptime": 1,
      "connected": true,
      "lasttotalreceived": 1,
      "lasttotalsent": 1,
      "latency": 1,
      "node_name": "text",
      "percentup": 1,
      "totalreceived": 1,
      "totalsent": 1,
      "totaltime": 1,
      "uptime": 1
    }
  },
  "network": "text",
  "node_id": "text",
  "node_name": "text",
  "updated_at": "text"
}

Get metrics for all nodes in a network

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/metrics/{network}

HTTPcURLJavaScriptPython

GET /api/metrics/{network} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "connectivity": {
        "ANY_ADDITIONAL_PROPERTY": {
          "actualuptime": 1,
          "connected": true,
          "lasttotalreceived": 1,
          "lasttotalsent": 1,
          "latency": 1,
          "node_name": "text",
          "percentup": 1,
          "totalreceived": 1,
          "totalsent": 1,
          "totaltime": 1,
          "uptime": 1
        }
      },
      "network": "text",
      "node_id": "text",
      "node_name": "text",
      "updated_at": "text"
    }
  }
}

Get metrics for a specific node

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

nodeidstringRequired

Node ID

Responses

200

OK

application/json

networkstringOptional

node_idstringOptional

node_namestringOptional

updated_atstringOptional

500

Internal Server Error

application/json

get

/api/metrics/{network}/{nodeid}

HTTPcURLJavaScriptPython

GET /api/metrics/{network}/{nodeid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "connectivity": {
    "ANY_ADDITIONAL_PROPERTY": {
      "actualuptime": 1,
      "connected": true,
      "lasttotalreceived": 1,
      "lasttotalsent": 1,
      "latency": 1,
      "node_name": "text",
      "percentup": 1,
      "totalreceived": 1,
      "totalsent": 1,
      "totaltime": 1,
      "uptime": 1
    }
  },
  "network": "text",
  "node_id": "text",
  "node_name": "text",
  "updated_at": "text"
}