Creating a system event message to test the API

You can use Swagger to create a message in the system event log. This is a simple way to test the management API. After the event has been created, you can display the message using the GET function on the Swagger page or using the NAS Bridge user interface.

Before you begin

You must have the following parameters:

Steps

  1. On the Swagger page, click system_events.
  2. Click POST to display the API call used to create a new system event.
  3. Type the version (which must always be 2), email address (that is, user account), and the authentication token.
    If you copied the authentication token after previously creating a new session, you can paste the token into the field on the page.
  4. Type a test message, severity (from the list of allowed values), and test facility:


    example test message

  5. Click Try it out.


    example response body

    The response code 200 indicates success.
  6. To verify the new message was created:
    • On the Swagger page, click system_events > GET, enter an email address and the authentication token. Use the q parameter to limit the results to those messages that include all or part of your message text. Then, click Try it out to list the message you created.


      example get system events


      example response body

    • From the NAS Bridge user interface, click Maintenance > Events, and filter or sort the events for the message you posted.


      example Maintenance > Events