NBI telemetry API

On this page

NBI telemetry API allows remote agents to push collected metrics to NOC. Refer to NBI Objectmetrics API for details on metrics retrieval.

Usage

POST /api/nbi/telemetry

Push bunch of metrics to NOC.

Example Request:

POST /api/nbi/telemetry HTTP/1.1
Host: noc.example.com
Private-Token: 12345

{
    "bi_id": "123456",
    "metrics": [
        {
            "metric_type": "Interface | Load | In",
            "path": ["", "", "", "Fa0/1"],
            "values": [
                ["2019-04-08T13:50:00", 12000],
                ["2019-04-08T13:55:00", 12200],
                ["2019-04-08T14:00:00", 50000]
            ]
        },
        {
            "metric_type": "Interface | Load | Out",
            "path": ["", "", "", "Fa0/1"],
            "values": [
                ["2019-04-08T13:50:00", 500000],
                ["2019-04-08T13:55:00", 520000],
                ["2019-04-08T14:00:00", 540000]
            ]
        },
    ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: text/json

"OK"
Request JSON Object:
 
  • bi_id (string) – Managed Object’s BI ID
  • metric_type (string) – Name of Metric Type
Request JSON Array of Objects:
 
  • metrics (array) – List of metrics
  • path (array) – Metric Path. Refer to Metric Scopes for details
  • values (array) – Array of pairs [timestamp, value]. Where timestamp is in ISO 8601 format (i.e. YYYY-MM-DDTHH:MM:SS)
Request Headers:
 
  • Private-TokenAPI Key with nbi:telemetry API access
Status Codes: