Skip to main content
Skip table of contents

Control via the API

Control via the API

The Silent Brick System includes an API accessible externally from version 2.15.0.9 onwards.

This enables both control and monitoring tasks to be executed without accessing the user interface.

See alsoGitHub.com - FAST-LTA

API control is performed exclusively via the management port of the Silent Brick System, provided that management and data networks are separated.

Description

Complete documentation of all supported API functions is available in the published materials on GITHUB:

Public API Description

Installation

Severalexamplesfor using the Silent Brick API in the form of scripts written in the languages

  • Perl

  • Powershell

Naturally, the API can also be accessed from any other scripting or programming languages.

examples

Monitor System Status

Using appropriate scripts, the following values can be queried from the system to monitor its status:

  • Status of the Silent Brick System via the Open Issues list

    • Warn on open warnings

    • Warn on open errors

  • Fill level of specific Secure NAS Volumes

    • Warning upon reaching threshold values

Automatically create snapshots

Using appropriate scripts, snapshots can be created on designated target Volumes.

This allows, for example, the automatic generation of a snapshot after creating a backup to freeze the state and protect it against unintended changes.

Similarly, old snapshots can be cleaned up based on their timestamps.

The examples provided, as well as the example scripts available in the linked GitHub repository, serve solely as an introduction and guidance. These scripts are not part of the official test plan and only provide a framework for the potential development of custom solutions.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.