--- title: "Get Server Information" method: GET path: "/connect/info/" tags: ["Grid"] --- # Get Server Information `GET /connect/info/` Requests the Security Onion grid general details. ## Response `200` The retrieved Info object - ModelInfo - `customReports` object — The list of custom reports configured for this grid. The key is the filename and the value is the report title. - `elasticVersion` string — The version of the Elasticsearch cluster - `forceUserOtp` boolean — OTP indicator; unavailable to API clients - `license` string — The copyright license applicable to the Security Onion software - `licenseKey` LicensingLicenseKey — The configured license key; available only if this is a Security Onion Pro grid - `dataUrl` string — The backend data event storage hostname required to be used by this license key - `effective` string — The date and time when this license key becomes effective - `expiration` string — The date and time when this license key expires - `features` string[] — The features included with this license key - `id` string — The unique ID for this license key - `licensee` string — The name of the organization to which this license key was issued - `mgmtMac` string — The management NIC MAC address pinned to this license - `name` string — The name of the license key. - `nodes` integer — The count of critical grid nodes supported by this license key; 0 = unlimited - `socUrl` string — The base URL required to be used by this license key - `subgrids` integer — The maximum allowed count of suboordinate grids managed by this grid - `users` integer — The count of users supported by this license key; 0 = unlimited - `licenseStatus` string — The license status of the grid: active = Valid Security Onion Pro license, unprovisioned = Community license - `mgmtMac` string — The MAC address assigned to the management interface. - `parameters` ModelClientParameters — Web UI parameters; unavailable to API clients - `alerts` ModelAlertingParameters - `ackEnabled` boolean - `actions` ModelHuntingAction[] - `background` boolean - `backgroundFailureLink` string - `backgroundSuccessLink` string - `body` string - `categories` string[] - `description` string - `fields` string[] - `icon` string - `jsCall` string - `link` string - `links` string[] - `method` string - `name` string - `options` object - `target` string - `advanced` boolean - `aggregationActionsEnabled` boolean - `chartLabelFieldSeparator` string - `chartLabelMaxLength` integer - `chartLabelOtherLimit` integer - `createLink` string - `detectionEngineStatusQueries` string - `escalateEnabled` boolean - `escalateRelatedEventsEnabled` boolean - `eventFetchLimit` integer - `eventFields` object - `eventItemsPerPage` integer - `groupFetchLimit` integer - `groupItemsPerPage` integer - `maxBulkEscalateEvents` integer - `mostRecentlyUsedLimit` integer - `queries` ModelHuntingQuery[] - `description` string - `name` string - `query` string - `showSubtitle` boolean - `queryBaseFilter` string - `queryToggleFilters` ModelToggleFilter[] - `disablesToggles` string[] - `enabled` boolean - `enablesToggles` string[] - `exclusive` boolean - `filter` string - `name` string - `relativeTimeUnit` integer - `relativeTimeValue` integer - `safeStringMaxLength` integer - `viewEnabled` boolean - `apiTimeoutMs` integer - `assistant` ModelAssistantParameters - `availableModels` ModelModelParameters[] - `adapter` string - `contextLimitLarge` integer - `contextLimitSmall` integer - `displayName` string - `enabled` boolean - `id` string - `lowBalanceColorAlert` integer - `origin` string - `compressContextPrompt` string - `enabled` boolean - `investigationPrompt` string - `thresholdColorRatioLow` number - `thresholdColorRatioMax` number - `thresholdColorRatioMed` number - `cacheExpirationMs` integer - `case` ModelCaseParameters - `analyzerNodeId` string - `mostRecentlyUsedLimit` integer - `presets` object - `renderAbbreviatedCount` integer - `cases` ModelHuntingParameters - `ackEnabled` boolean - `actions` ModelHuntingAction[] - `background` boolean - `backgroundFailureLink` string - `backgroundSuccessLink` string - `body` string - `categories` string[] - `description` string - `fields` string[] - `icon` string - `jsCall` string - `link` string - `links` string[] - `method` string - `name` string - `options` object - `target` string - `advanced` boolean - `aggregationActionsEnabled` boolean - `chartLabelFieldSeparator` string - `chartLabelMaxLength` integer - `chartLabelOtherLimit` integer - `createLink` string - `detectionEngineStatusQueries` string - `escalateEnabled` boolean - `escalateRelatedEventsEnabled` boolean - `eventFetchLimit` integer - `eventFields` object - `eventItemsPerPage` integer - `groupFetchLimit` integer - `groupItemsPerPage` integer - `mostRecentlyUsedLimit` integer - `queries` ModelHuntingQuery[] - `description` string - `name` string - `query` string - `showSubtitle` boolean - `queryBaseFilter` string - `queryToggleFilters` ModelToggleFilter[] - `disablesToggles` string[] - `enabled` boolean - `enablesToggles` string[] - `exclusive` boolean - `filter` string - `name` string - `relativeTimeUnit` integer - `relativeTimeValue` integer - `safeStringMaxLength` integer - `viewEnabled` boolean - `casesEnabled` boolean - `cheatsheetUrl` string - `dashboards` ModelHuntingParameters - `ackEnabled` boolean - `actions` ModelHuntingAction[] - `background` boolean - `backgroundFailureLink` string - `backgroundSuccessLink` string - `body` string - `categories` string[] - `description` string - `fields` string[] - `icon` string - `jsCall` string - `link` string - `links` string[] - `method` string - `name` string - `options` object - `target` string - `advanced` boolean - `aggregationActionsEnabled` boolean - `chartLabelFieldSeparator` string - `chartLabelMaxLength` integer - `chartLabelOtherLimit` integer - `createLink` string - `detectionEngineStatusQueries` string - `escalateEnabled` boolean - `escalateRelatedEventsEnabled` boolean - `eventFetchLimit` integer - `eventFields` object - `eventItemsPerPage` integer - `groupFetchLimit` integer - `groupItemsPerPage` integer - `mostRecentlyUsedLimit` integer - `queries` ModelHuntingQuery[] - `description` string - `name` string - `query` string - `showSubtitle` boolean - `queryBaseFilter` string - `queryToggleFilters` ModelToggleFilter[] - `disablesToggles` string[] - `enabled` boolean - `enablesToggles` string[] - `exclusive` boolean - `filter` string - `name` string - `relativeTimeUnit` integer - `relativeTimeValue` integer - `safeStringMaxLength` integer - `viewEnabled` boolean - `detection` ModelDetectionParameters - `presets` object - `severityTranslations` object - `showUnreviewedAiSummaries` boolean - `templateDetections` object - `detections` ModelDetectionsParameters - `ackEnabled` boolean - `actions` ModelHuntingAction[] - `background` boolean - `backgroundFailureLink` string - `backgroundSuccessLink` string - `body` string - `categories` string[] - `description` string - `fields` string[] - `icon` string - `jsCall` string - `link` string - `links` string[] - `method` string - `name` string - `options` object - `target` string - `advanced` boolean - `aggregationActionsEnabled` boolean - `chartLabelFieldSeparator` string - `chartLabelMaxLength` integer - `chartLabelOtherLimit` integer - `createLink` string - `detectionEngineStatusQueries` string - `escalateEnabled` boolean - `escalateRelatedEventsEnabled` boolean - `eventFetchLimit` integer - `eventFields` object - `eventItemsPerPage` integer - `groupFetchLimit` integer - `groupItemsPerPage` integer - `mostRecentlyUsedLimit` integer - `presets` object - `queries` ModelHuntingQuery[] - `description` string - `name` string - `query` string - `showSubtitle` boolean - `queryBaseFilter` string - `queryToggleFilters` ModelToggleFilter[] - `disablesToggles` string[] - `enabled` boolean - `enablesToggles` string[] - `exclusive` boolean - `filter` string - `name` string - `relativeTimeUnit` integer - `relativeTimeValue` integer - `safeStringMaxLength` integer - `viewEnabled` boolean - `detectionsEnabled` boolean - `docsUrl` string - `exportNodeId` string - `grid` ModelGridParameters - `maxUploadSize` integer - `staleMetricsMs` integer - `hunt` ModelHuntingParameters - `ackEnabled` boolean - `actions` ModelHuntingAction[] - `background` boolean - `backgroundFailureLink` string - `backgroundSuccessLink` string - `body` string - `categories` string[] - `description` string - `fields` string[] - `icon` string - `jsCall` string - `link` string - `links` string[] - `method` string - `name` string - `options` object - `target` string - `advanced` boolean - `aggregationActionsEnabled` boolean - `chartLabelFieldSeparator` string - `chartLabelMaxLength` integer - `chartLabelOtherLimit` integer - `createLink` string - `detectionEngineStatusQueries` string - `escalateEnabled` boolean - `escalateRelatedEventsEnabled` boolean - `eventFetchLimit` integer - `eventFields` object - `eventItemsPerPage` integer - `groupFetchLimit` integer - `groupItemsPerPage` integer - `mostRecentlyUsedLimit` integer - `queries` ModelHuntingQuery[] - `description` string - `name` string - `query` string - `showSubtitle` boolean - `queryBaseFilter` string - `queryToggleFilters` ModelToggleFilter[] - `disablesToggles` string[] - `enabled` boolean - `enablesToggles` string[] - `exclusive` boolean - `filter` string - `name` string - `relativeTimeUnit` integer - `relativeTimeValue` integer - `safeStringMaxLength` integer - `viewEnabled` boolean - `inactiveTools` string[] - `job` ModelHuntingParameters - `ackEnabled` boolean - `actions` ModelHuntingAction[] - `background` boolean - `backgroundFailureLink` string - `backgroundSuccessLink` string - `body` string - `categories` string[] - `description` string - `fields` string[] - `icon` string - `jsCall` string - `link` string - `links` string[] - `method` string - `name` string - `options` object - `target` string - `advanced` boolean - `aggregationActionsEnabled` boolean - `chartLabelFieldSeparator` string - `chartLabelMaxLength` integer - `chartLabelOtherLimit` integer - `createLink` string - `detectionEngineStatusQueries` string - `escalateEnabled` boolean - `escalateRelatedEventsEnabled` boolean - `eventFetchLimit` integer - `eventFields` object - `eventItemsPerPage` integer - `groupFetchLimit` integer - `groupItemsPerPage` integer - `mostRecentlyUsedLimit` integer - `queries` ModelHuntingQuery[] - `description` string - `name` string - `query` string - `showSubtitle` boolean - `queryBaseFilter` string - `queryToggleFilters` ModelToggleFilter[] - `disablesToggles` string[] - `enabled` boolean - `enablesToggles` string[] - `exclusive` boolean - `filter` string - `name` string - `relativeTimeUnit` integer - `relativeTimeValue` integer - `safeStringMaxLength` integer - `viewEnabled` boolean - `releaseNotesUrl` string - `tipTimeoutMs` integer - `tools` ModelClientTool[] - `description` string - `icon` string - `link` string - `name` string - `target` string - `webSocketTimeoutMs` integer - `srvToken` string — The server token; unavailable to API clients - `subgrids` ModelSubgrid[] — The list of subordinate grids configured for this grid. - `caCertificate` string — Subgrid Certificate Authority cert in PEM format, if available" - `clientId` string — The Client ID generated by the API Client interface, used to authenticate to this subgrid - `clientSecret` string — The Client Secret generated by the API Client interface, used to authenticate to this subgrid - `enabled` boolean — Flag that controls whether this subgrid is enabled or not - `id` string — A unique, admin-assigned identifier string for this subgrid - `managerUrl` string — The base URL for this subgrid, used by manager overseer nodes to access this subgrid - `skipTlsVerify` boolean — Flag that allows the skipping of TLS certification validation; useful for test environments - `timezones` string[] — The timezones that are configured for this server. - `userId` string — The authenticated API client ID - `version` string — The version of the Security Onion grid ## Other responses - `401` — Request was not properly authenticated - `500` — Internal SOC error; review SOC logs --- [API](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api.md) · [All operations](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/security-onion-solutions/security-onion-connect-api/versions/0576ce393f8d/schema)