Enable the AAI Subscription API
search cancel

Enable the AAI Subscription API

book

Article ID: 236756

calendar_today

Updated On:

Products

Automation Analytics & Intelligence

Issue/Introduction

How do I enable the AAI Subscription API?

Environment

AAI All Versions

Resolution

  1. Subscribe to subscriptions you wish to receive via the Swagger JAWS Subscriptions page.
    http://<aai hostname>:8080/subscriptionService/swagger-ui.html#/

    For example: If you want to subscribe to AAI Alerts, you can use POST /subscription/alerts and you would use your API End Point that would be receiving the subscription alerts.
  2. Enable subscription.* parameters in the Configuration tool for the subscriptions you wish to receive.
    For example: For Alerts enable the subscriptions.publishAlerts parameter.
  3. Set the SubscriptionService logger to DEBUG.
  4. You can verify the subscriptions are being sent by reviewing the subscriptions.log in the /<Install Dir>/jboss/standalone/log directory.

Additional Information

See our online documentation: REST API Specification for Subscription Services for more information about the subscription API.

Note: If you don't find com.termalabs.subscriptions.SubscriptionService in all loggers then do the following steps:

  1. Select "Add by name".
  2. Copy / paste the following into the box: com.termalabs.subscriptions.SubscriptionService.
  3. Then you can set the level as debug.