v1

latestOpenAPI 3.1.0Elastic 2.02026-07-179371211.2 KB

Grid

Get Server Information

Requests the Security Onion grid general details.

get/connect/info/

Response

The retrieved Info object

customReportsobject

The list of custom reports configured for this grid. The key is the filename and the value is the report title.

elasticVersionstring

The version of the Elasticsearch cluster

forceUserOtpboolean

OTP indicator; unavailable to API clients

licensestring

The copyright license applicable to the Security Onion software

licenseStatusstring

The license status of the grid: active = Valid Security Onion Pro license, unprovisioned = Community license

mgmtMacstring

The MAC address assigned to the management interface.

srvTokenstring

The server token; unavailable to API clients

timezonesstring[]

The timezones that are configured for this server.

userIdstring

The authenticated API client ID

versionstring

The version of the Security Onion grid

Example response

{
  "elasticVersion": "8.14.3",
  "license": "Elastic License 2.0 (ELv2)",
  "licenseKey": {
    "effective": "2024-08-22T00:00:00Z",
    "expiration": "2025-08-22T23:59:59Z",
    "features": [
      "NTF"
    ],
    "id": "acme_corp_20240822",
    "licensee": "Acme Corp",
    "mgmtMac": "10:20:30:A0:B0:C0",
    "name": "Security Onion Pro",
    "nodes": 5,
    "socUrl": "acme-so-manager",
    "subgrids": 2
  },
  "licenseStatus": "active",
  "mgmtMac": "11:22:33:AA:BB:CC",
  "subgrids": [
    {
      "caCertificate": "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----\n",
      "clientId": "socl_my_client_id",
      "clientSecret": "xSff24sSvkKJaMN24",
      "id": "subgrid_b",
      "managerUrl": "https://subgrid_host_name",
      "skipTlsVerify": true
    }
  ],
  "timezones": [
    "Africa/Abidjan"
  ],
  "userId": "socl_my_so_api_client",
  "version": "2.4.110"
}