Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

NorthStar REST API Notifications

This feature allows third-party applications to receive NorthStar Controller event notifications by subscribing to the NorthStar REST API push notification service. The notifications are pushed by way of the socket.io interface. The following event types are included:

  • Node (nodeEvent)

  • Link (linkEvent)

  • LSP (lspEvent)

  • P2MP (p2mpEvent)

  • Facility (facilityEvent)

  • HA (haEvent)

Table 1 lists the schema for each of these event notification types.

Table 1: NorthStar Event Notification Types

Event Type

Schema

Description

nodeEvent

topology_v2.json#/definitions/nodeNotification

Node event notification.

linkEvent

topology_v2.json#/definitions/linkNotification

Link event notification.

lspEvent

topology_v2.json#/definitions/lspNotification

LSP event notification.

p2mpEvent

topology_v2.json#/definitions/p2mpGroupNotification

P2MP group event notification. The LSPs in the update are reduced to their lspIndex values to reduce the size of the event.

facilityEvent

topology_v2.json#/definitions/facilityNotification

Facility/SRLG event notification.

haEvent

topology_v2.json#/definitions/haHostNotification

Node state event notification. Only update (no add or remove) events are supported. The notification does not include the list of processes and only contains operational information.

healthEvent

topology_v2.json#/definitions/ healthThresholdNotification

Node health event notification. Only update (no add or remove) events are supported. The notifications include utilization of CPU, disk, memory that exceed certain threshold, and processes status.

Examples

Note:

The following examples are written in Python. Lines preceded by # are comments.

To ensure secure access, a third party application must be authenticated before it can receive NorthStar event notifications. Use the NorthStar OAuth2 authentication API to obtain a token for authentication purposes. The token allows subscription to the socket.io channel. The following example shows connecting to NorthStar and requesting a token.

The following example retrieves the NorthStar topology nodes and links.

The following example subscribes to the NorthStar REST API push notification service.