NBI config API

On this page

NBI config API allows remote system to fetch Managed Object’s configuration, eigther last of specified revision

Usage

Get last config

GET /api/nbi/config/(int: object_id)

Get last configuration for Managed Object with id object_id

Example Request

GET /api/nbi/config/333 HTTP/1.1
Host: noc.example.com
Private-Token: 12345

Example Response

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

!
hostname Switch
...
Parameters:
  • object_id – Managed Object’s id.
Request Headers:
 
  • Private-TokenAPI Key with nbi:config API access.
Status Codes:

Get config by revision

GET /api/nbi/config/(int: object_id)/(str:revision id)

Get configuration revision revision_id for Managed Object with id object_id

Example Request

GET /api/nbi/config/333/5c03cb4cc04567000830be73 HTTP/1.1
Host: noc.example.com
Private-Token: 12345

Example Response

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

!
hostname Switch
...
Parameters:
  • object_id – Managed Object’s id
  • revision – Config revision. Can be obtained via configrevisions API
Request Headers:
 
  • Private-TokenAPI Key with nbi:config API access
Status Codes: