System Console API Documentation

Overview

This documentation provides a comprehensive guide to the System Console API. It covers core concepts, API endpoints, and common usage examples.

You can access the API endpoint at: System Console API Documentation

Key Concepts

The System Console API allows you to interact with the backend systems via a standardized command.

Common functionalities include:

  • System Logging: Capture and analyze system events.
  • Data Extraction: Retrieve specific data fields from various systems.
  • Command Execution: Trigger system-level actions.

API Endpoints

Here are some key API endpoints:

  • /api/system/console/read-data: Read system data (Example: Log Events).
  • /api/system/console/write-data: Write data to the system.
  • /api/system/console/update-status: Update system status.
  • /api/system/console/list-endpoints: List available endpoint names.