Supported Data Flows
All data flows are implemented as REST web services.
Outgoing Flows
Publish Outage Notifications
Outage information is published as a POST request to the URL specified by the configuration parameter config.publish.url.
Supported Authentication Methods
When publishing outage notifications, the adapter can use the following authentication methods.
Basic HTTP Authentication
With this authentication method the credentials needed to access the web service to publish outage notifications are passed directly in the Authorization HTTP header of the outgoing message. This method is used when the configuration parameter config.auth.url is not specified.
Note: With this authentication method only HTTPS transport should be used to publish outage data to avoid security credentials from being compromised.
OAuth Authentication
The adapter can use the OAuth 2.0 client credentials flow to obtain a token from the OAuth server using configured credentials and (optionally) scope, and then use the obtained token when publishing outage notifications. This method is used when the configuration parameter config.auth.url is specified.
OpenAPI Specification
The adapter publishes OpenAPI specification (version 3.0.1) of the outbound REST API that it uses to publish outage notification. It can be used to obtain format of the JSON messages the adapter publishes.
The OpenAPI specification can be access at the following URL:
https://<host>:<port>/nms-nhub/openapi-nhub.json