Introduction to the REST: Toolkit PowerPack

Download this manual as a PDF file 

This section describes how to use the "REST: Toolkit" PowerPack.

What is the Snippet Framework?

Snippet Dynamic Applications on SL1 provide a flexible and powerful way to solve common monitoring problems. With snippet Dynamic Applications, a developer can solve nearly any collection problem for a monitoring need, given enough time and code.

The low-code Snippet Framework builds on traditional snippet Dynamic Applications and lets you solve common monitoring problems quickly, while still providing for customization to let you address more complex problems.

What Does the REST: Toolkit PowerPack Include?

The Snippet Framework provides a standard way to write Dynamic Applications using snippet arguments to define what to collect, how to collect it, where to get the data, and how to interpret it. This process is snippet argument driven, meaning that you direct the Snippet Framework using snippet arguments in a Dynamic Application. Users can configure the "REST Snippet Framework" credential for REST Authentication configuration. Users can then identify authentication issues by using the credential's supported self-debug capabilities.

The "REST: Toolkit" PowerPack includes the following features:

  • Libraries that provide REST-specific steps, as well as an execution environment with REST and other standard steps necessary for REST Dynamic Application development.
  • Example snippet Dynamic Applications that enable SL1 to collect configuration and performance data from REST APIs.
  • Dynamic Applications that enable SL1 to discover, model, and monitor an SL1 system on which you can create and experiment with the snippet Dynamic Applications that you build.
  • Support for basic authentication APIs.

The "REST: Toolkit" PowerPack is the end-product of what one would build when following the Snippet Framework development tutorial docs. Full documentation provided at the link below.

Installing the Snippet Framework: REST Toolkit PowerPack

Before you can use the Snippet Framework, you must import and install the latest version of the Snippet Framework: REST Toolkit PowerPack.

To download and install a PowerPack:

  1. Download the PowerPack from the ScienceLogic Support Site.
  2. Go to the PowerPack Manager page (System > Manage > PowerPacks).
  3. In the PowerPack Manager page, click the Actions button, then select Import PowerPack.
  4. The Import PowerPack dialog box appears.

  5. Click the [Browse] button and navigate to the PowerPack file.
  6. When the PowerPack Installer modal appears, click the Install button to install the PowerPack.

If you exit the PowerPack Installer without installing the imported PowerPack, the imported PowerPack will not appear in the PowerPack Manager page. However, the imported PowerPack will appear in the Imported PowerPacks page. This page appears when you click the Actions menu and select Install PowerPack.

Documentation for the Snippet Framework

Full documentation for the Snippet Framework is provided at the following location:

https://docs.sciencelogic.com/dev-docs