GUI Features

Identify the product and the GUI features enabled on the device

These two endpoints are used by the web interface to name the product before login and to decide which parts of the GUI to show after login. Other clients can use them to detect the platform and the analysis features covered by the license.

API

• Get product information

  • Path: /api/gui_info

  • Method: GET

  • Minimum user role: none (no token required)

  • Response on success (200 OK):

    {
        "message": "Success",
        "data": {
            "title": "IOTA 10 CORE PLUS",
            "logo": "iota",
            "profitap_logo": true
        }
    }

    • title - product name: IOTA 100 CORE or IOTA 10 CORE PLUS
    • logo - logo identifier, always iota on IOTA products
    • profitap_logo - whether the Profitap logo is shown
• Get GUI features

  • Path: /api/gui_features

  • Method: GET

  • Minimum user role: viewer

  • Response on success (200 OK):

    {
        "message": "Success",
        "data": {
            "title": "IOTA 10 CORE PLUS | iota-xos-sys",
            "features": [
                "iota_core_dashboards",
                "iota_core_capture_control",
                "iota_core_data_vault",
                "iota_core_settings",
                "iota_tcp_analysis_available",
                "iota_dns_analysis_available",
                "iota_http_analysis_available",
                "iota_rtp_analysis_available"
            ],
            "platform": "core10_plus"
        }
    }

    • title - product name followed by the hostname of the device
    • features - GUI parts enabled on this device. The first four are always present: iota_core_dashboards, iota_core_capture_control, iota_core_data_vault, iota_core_settings. The others depend on the license: iota_tcp_analysis_available, iota_dns_analysis_available, iota_http_analysis_available, iota_rtp_analysis_available
    • platform - core100 or core10_plus

  • Response on failure (500 Internal Server Error): {"message": "could not get the GUI features", "data": null} when the license information cannot be read from the hardware controller service

Back to Index