SG SealGrid Athena Docs

General Settings

The Settings → General tab holds the console-wide preferences that shape how Athena looks and behaves for everyone who signs in: the display language, the date/time format, the default number of rows in tables, how often the dashboard refreshes itself, and the server's public URL that agents use to download installers and updates. This page explains each setting, its default and allowed choices, and how to read or change it from the console, the REST API, and PowerShell.

Admin only

Reading and changing General settings requires the Admin role. See Roles & Permissions. Every change is written to the audit trail.

Where to find it#

Open Settings → General in the console. The tab groups the preferences into three sections, each with its own Save action:

Values you set here are stored in the server's configuration. Because these are read from configuration, changing the display language or the public URL is best applied during a maintenance window so the whole console and every agent-facing download link pick up the new value consistently.

Language#

The Language Settings section sets the display language for the console. Two languages ship today:

SettingDefaultChoicesWhat it does
Current Language English (en) English (en), עברית / Hebrew (he) Selects the language Athena uses for labels, menus, and messages across the console.

Hebrew is a right-to-left language, so choosing it also flips the console layout to right-to-left. The language is saved as a two-letter code (en or he).

Display settings#

The Display Settings section controls how data is presented throughout the application. All three are chosen from fixed drop-downs, so there are no invalid values to worry about.

SettingDefaultChoicesWhat it does
Date/Time Format yyyy/MM/dd HH:mm:ss yyyy/MM/dd HH:mm:ss, dd/MM/yyyy HH:mm:ss, MM/dd/yyyy HH:mm:ss, yyyy-MM-dd HH:mm:ss The pattern used to display dates and times throughout the console (for example on agent last-seen times and job timestamps).
Default Page Size 25 10, 25, 50, 100 How many rows tables and lists show per page before paging. Larger values mean fewer pages but more rows on screen at once.
Dashboard Refresh Interval 30 seconds Disabled, 10 s, 30 s, 60 s How often the dashboard re-fetches its live figures. Choose Disabled to stop automatic refresh and update only on manual reload.
Time-zone note

The Date/Time Format controls only the pattern in which dates and times are written, not the time zone. It does not include a time-zone offset, so times are shown in the format you pick using the server's clock.

Server settings — Public URL#

The Server Settings section holds a single but important value: the Public URL. This is the address by which agents reach this server — the host (and port) Athena writes into the download links it hands out for agent installers, agent binary updates, and package and deployment payloads.

SettingDefaultWhat it does
Public URL https://localhost:8443 The server address reachable by agents (for example https://192.168.1.100:8443). Athena uses this host when generating the download URLs that agents and installers fetch from.
Set the Public URL to a reachable address

The shipped default, https://localhost:8443, only works on the server host itself. In a real deployment, set the Public URL to a hostname or IP that your agents can actually reach — otherwise generated installer and update download links will point back at localhost and agents will fail to fetch them. Use the same value your agents were enrolled against. See Agent Enrollment and Configuration.

REST API#

The same settings are available over the JWT-authenticated REST API on port 8443. Send the bearer token as Authorization: Bearer <token>; both endpoints require the Admin role.

EndpointRolePurpose
GET api/settings/generalAdminRead the current language, display, and server (Public URL) settings.
PUT api/settings/generalAdminUpdate the general settings. Send the full settings object.
GET api/settingsAdminRead every settings category at once, including General.
# Read current general settings
curl -k -H "Authorization: Bearer <token>" \
  https://athena.example.com:8443/api/settings/general

# Update: US date format, 50 rows per page, 60s dashboard refresh,
# and point agents at a reachable public URL
curl -k -X PUT -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "language": "en",
    "dateTimeFormat": "MM/dd/yyyy HH:mm:ss",
    "defaultPageSize": 50,
    "dashboardRefreshInterval": 60,
    "publicUrl": "https://192.168.1.100:8443"
  }' \
  https://athena.example.com:8443/api/settings/general

Send the object you read back from GET with the fields you want to change — the update replaces the general settings with the values you supply.

PowerShell#

The Athena PowerShell module reads and writes the general settings with Get-AthenaSettings and Set-AthenaSettings using the General category. Sign in with Connect-Athena as an Admin first.

# Connect as an Admin
Connect-Athena -Server "athena.contoso.com"

# Read the current general settings
$general = Get-AthenaSettings -Category General
$general.DefaultPageSize
$general.PublicUrl

# Show 50 rows per page and refresh the dashboard every 60 seconds
$general.DefaultPageSize = 50
$general.DashboardRefreshInterval = 60
Set-AthenaSettings -Category General -Settings $general

# Point agents at a reachable public URL
$general.PublicUrl = "https://192.168.1.100:8443"
Set-AthenaSettings -Category General -Settings $general

Set-AthenaSettings supports -WhatIf/-Confirm, so you can preview a change or gate it in a script.

Auditing#

Every change to the general settings is written to the audit trail as a General settings change, recording the acting user, their IP address, and which values changed — for example a change to the display language, the default page size, or the Public URL. This gives you a complete record of who adjusted the console preferences and when.