Introduction to the REST: Toolkit PowerPack

Download this manual as a PDF file 

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

The "REST: Toolkit" PowerPack has been superseded by the "Low-code Tools" PowerPack, a single PowerPack that provides CLI, REST, and Prometheus collection steps together. ScienceLogic recommends the "Low-code Tools" PowerPack for all new Snippet Framework development. For more information, see the Low-code Tools PowerPack manual.

What is the REST: Toolkit PowerPack?

The "REST: Toolkit PowerPack" adds REST API collection capabilities to the Snippet Framework. The Snippet Framework is the recommended method for building Snippet Dynamic Applications in Skylar One. Rather than writing Python code to collect data, you use Snippet Arguments to define what to collect, and the framework runs a series of prebuilt steps to perform the collection. A toolkit is a PowerPack that supplies a set of these prebuilt steps for a particular collection method.

The"REST: Toolkit PowerPack supplies the steps used to collect configuration and performance data from any technology that has a REST API endpoint, which reduces or removes the need to write Python for REST-based monitoring.

If you are not already familiar with the Snippet Framework, see the Snippet Framework manual before using this PowerPack. The "Introduction to Snippet Framework" chapter explain what the framework is and how it works, the "Snippet Framework Collection Pipeline" chapter explains steps and the execution model, and the "Snippet Framework Toolkits and Execution Environments" chapter explains how toolkits such as the REST: Toolkit supply steps to the framework.

What Does the REST: Toolkit PowerPack Include?

The Snippet Framework libraries that provide the core functionality shared by all toolkits. Common out-of-the-box steps that are available in all toolkits, along with REST-specific steps that are used only when building REST PowerPacks.

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

  • An execution environment with the REST and standard steps needed for REST Dynamic Application development.

  • Example Snippet Dynamic Applications that enable Skylar One to collect configuration and performance data from REST APIs.

  • Dynamic Applications that enable Skylar One to discover, model, and monitor a Skylar One system, so you can create and experiment with the Snippet Dynamic Applications that you build.

  • The silo_low_code library.

  • A template PowerPack implementation that demonstrates the use of the required steps.

  • A "REST Snippet Framework" credential for REST authentication configuration.

  • Support for these credential authentication types: Basic, Bearer Token, API Key, and Oauth2.

You can create and edit the REST Snippet Framework credential from Manage > Credentials. This credential type cannot be edited from System > Manage > Credentials, which returns an error.

Installing the REST: Toolkit PowerPack

To use the REST collection steps described in this manual, you must import and install the latest version of the "REST: Toolkit" PowerPack. The minimum Skylar One version for this PowerPack is 11.3.0.

If you have installed version 100 of the "CLI: Toolkit" PowerPack, or you have PowerPacks that were built using the "CLI: Toolkit" PowerPack, you must install version 101 of the "CLI: Toolkit" PowerPack before you install version 101 of the"REST: Toolkit" PowerPack, and align the Dynamic Applications built with version 101 of the "CLI: Toolkit" PowerPack to the execution environments included in version 101 of the "CLI: Toolkit" PowerPack. For more information about aligning Dynamic Applications to execution environments, see the "Managing Execution Environments" section of the ScienceLogic Libraries and Execution Environments manual.

To download and install a PowerPack:

  1. Search for and download the PowerPack from the PowerPacks page at the ScienceLogic Support Center (Skylar One > PowerPacks, login required).
  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.

Migrating to the Low-code Tools PowerPack

ScienceLogic recommends the "Low-code Tools" PowerPack for all new Snippet Framework development. The "Low-code Tools" PowerPack provides the REST collection steps described in this manual, along with steps for CLI, SNMP, Prometheus, JMX, WinRM, and PowerShell collection, in a single PowerPack. If you are starting new development, use the "Low-code Tools" PowerPack rather than the "REST: Toolkit" PowerPack. For more information, see the Low-code Tools PowerPack manual.

Documentation for the REST: Toolkit PowerPack

Full reference documentation for the REST: Toolkit, including supported authentication methods, the complete list of available steps, custom step development, and advanced features such as logging, troubleshooting, and performance, is provided in the REST: Toolkit developer documentation.