NBI objectstatus API

On this page

NBI objectstatus API allows to request current statuses for specified Managed Objects.

Usage

POST /api/nbi/objectstatus

Get current statuses for one or more Managed Objects.

Example Request:

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

{
    "objects": ["10", "11", "12", "13"]
}

Example Response:

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

{
    "statuses": [
        {"id": "10", "status": True},
        {"id": "11", "status": True},
        {"id": "12", "status": True},
        {"id": "13", "status": False}
    ]
}
Request JSON Array of Objects:
 
Response JSON Array of Objects:
 
  • string id (statuses) – Managed Object’s ID.
  • bool string (statuses) – true if object is up, false otherwise.
Status Codes: