Summary

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.

API Stability Preview

Syntax

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

For the input, you may give several parameters to change settings related to the user interface, including the kind of feature announcements to dismiss, and the user interface theme. See the Input Parameters section for details.

Example

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',
  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"
    }
  }
}

Input Parameters

For the input, you may give several parameters to change settings related to the user interface. The choices are listed in the table below. You can also choose the kind of feature announcements to dismiss (see the second table below), and the user interface theme (see third table).

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation. Since some of the parameters use special datatypes, additional tables for them are included below.
automaticallyHighlighting boolean     Use automatic highlighting.
automaticallySearch boolean     Search automatically.
defaultTimeZone boolean     The default time zone is used.
featureAnnouncementsToDismiss [FeatureAnnouncement]     The type of feature announcement to dismiss. See table below.
isCommunityMessageDismissed boolean     Whether the community message has been dismissed.
isEventListOrderedWithNewestAtBottom boolean     Whether event list is in descending order.
isFieldPanelOpenByDefault boolean     Whether field panel is open by default.
isGettingStartedMessageDismissed boolean     Whether the getting started message has been dismissed.
isWelcomeMessageDismissed boolean     Whether the welcome message has been dismissed.
isDarkModeMessageDismissed boolean     Whether the dark mode message has been dismissed. This is deprecated.
isPackageDocsMessageDismissed boolean     Whether the package documents message has been dismissed. This is deprecated.
isResizableQueryFieldMessageDismissed boolean     Whether the resizable query field message has been dismissed. This is deprecated.
uiTheme UiTheme     The user interface theme to use. See table below.

For this special datatype, you'll have to select the kind of feature announcements to dismiss. See the table below for a list of choices:

Table: FeatureAnnouncement Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
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.

This special datatype provides an enumerated list of values regarding the user interface theme.

Table: UiTheme Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
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.

Returned Values

For the results, you can get the user's UI theme, starred dashboards, time zone and many other individual settings. Below is a list choices along with descriptions:

Table: UserSettings Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 29, 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.
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.