API Stability Preview

The updateSettings() GraphQL mutation is used to set flags for user interface states and help messages. This field is a preview and not yet available.

For more information on configuring all aspects of LogScale, see the Configuration Settings reference section.

Syntax

Below is the syntax for the updateSettings() mutation field:

graphql
updateSettings(
     automaticallyHighlighting: boolean,
     automaticallySearch: boolean,
     defaultTimeZone: String,
     featureAnnouncementsToDismiss: [FeatureAnnouncement], 
     isCommunityMessageDismissed: boolean,
     isDarkModeMessageDismissed: boolean,
     isEventListOrderedWithNewestAtBottom: boolean,
     isFieldPanelOpenByDefault: boolean,
     isGettingStartedMessageDismissed: boolean,
     isPackageDocsMessageDismissed: boolean,
     isResizableQueryFieldMessageDismissed: boolean,
     isWelcomeMessageDismissed: boolean,
     uiTheme: UiTheme
   ): UserSettings!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updateSettings( 
    defaultTimeZone: "UTC-5"
  ) 
  { defaultTimeZone }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSettings( 
    defaultTimeZone: \"UTC-5\"
  ) 
  { defaultTimeZone }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSettings( 
    defaultTimeZone: \"UTC-5\"
  ) 
  { defaultTimeZone }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateSettings(  ^
    defaultTimeZone: \"UTC-5\" ^
  )  ^
  { defaultTimeZone } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateSettings( 
    defaultTimeZone: \"UTC-5\"
  ) 
  { defaultTimeZone }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateSettings( 
    defaultTimeZone: \"UTC-5\"
  ) 
  { defaultTimeZone }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateSettings( 
    defaultTimeZone: \"UTC-5\"
  ) 
  { defaultTimeZone }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateSettings( 
    defaultTimeZone: \"UTC-5\"
  ) 
  { defaultTimeZone }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateSettings": {
      "defaultTimeZone": "UTC-2"
    }
  }
}

Given Datatypes

The given datatype UiTheme has is an enumerated list of values:

Table: UiTheme

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: May 9, 2025
Auto   Long-TermThe display is set automatically to either light or dark mode.
Dark   Long-TermThe user interface display is dark mode.
Light   Long-TermThe user interface display is light mode.

The given datatype FeatureAnnouncement has is also an enumerated list of values:

Table: FeatureAnnouncement

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: May 8, 2025
FetchMoreOnFieldsPanel   PreviewUsed to indicate the feature announcement is a request to fetch more on fields panel.
FieldInteractions   PreviewIndicates the feature announcement is field interactions.
FilterMatchHighlighting   PreviewMakes the feature announcement a filter matching highlighting.
FleetRemoteUpdatesAndGroups   PreviewIndicates the feature announcement is related to Fleet remote updates and groups.
Interactions   PreviewThe feature announcement has to do with interactions.
OrganizationOwnedQueries   PreviewThe feature announcement relates to an organization's owned queries.
PuffinRebranding   PreviewSet to indicate the feature announcement is a Puffin rebranding.
ToolPanel   PreviewThe feature announcement is related to the Tool Panel.
TriggerOverview   PreviewIndicates the feature announcement is the trigger overview.
TriggerSearchPage   PreviewIndicates the feature announcement is the trigger search page.

Returned Datatypes

The returned datatype UserSettings has several parameters. Below is a list of them along with a description of each:

Table: UserSettings

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 10, 2025
defaultTimeZonestring  Long-TermDefault timezone preference for user. If not set, the default timezone is no longer taken from the organization.
featureAnnouncementsToShow[FeatureAnnouncement]yes PreviewList of feature announcements to show. See FeatureAnnouncement. This is a preview and subject to change.
isAutomaticHighlightingEnabledbooleanyes PreviewWhether automatic highlighting on the search page is enabled. This is a preview and subject to change.
isAutomaticSearchEnabledbooleanyes Short-TermWhether the automatic search been enabled.
isCommunityMessageDismissedbooleanyes Short-TermWhether the community message has been dismissed.
isDarkModeMessageDismissedbooleanyes Short-TermWhether the dark-mode message has been dismissed.
isEventListOrderedWithNewestAtBottombooleanyes Short-TermWhether there is an event list, ordered with newest last.
isFieldPanelOpenByDefaultbooleanyes Short-TermWhether the field panel is open by default.
isGettingStartedMessageDismissedbooleanyes Short-TermWhether the 'Getting Started' message has been dismissed.
isPackageDocsMessageDismissedbooleanyes Short-TermWhether the package documentation message has been dismissed.
isQuickStartCompletedbooleanyes Long-TermWhether the quick start has been completed.
isWelcomeMessageDismissedbooleanyes Short-TermWhether the welcome message has been dismissed.
starredAlerts[string]yes DeprecatedList of alerts that have been marked with a star. However, starring is no longer used in the UI and will be removed at the earliest in version 1.207.
starredDashboards[string]yes Long-TermList of dashboards that have been marked with a star.
starredSearchDomains[string]yes Long-TermList of searchdomains that have been marked with a star.
uiThemeUiThemeyes Long-TermThe user interface theme choice. See UiTheme.