Stability Level Long-Term

Summary

The clusterConfig() GraphQL query will return information about a cluster configuration. Requires authentication.

Syntax

graphql
clusterConfig: ClusterConfig!

There is no input for this query. You need only specify the values you want returned, such as what's enabled and allowed. See the Returned Values section for details.

Example

Raw
graphql
query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}
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" : "query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}"
}
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" : "query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}"
}
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" : "query { ^
  clusterConfig { clusterId,  ^
                  isExternalManaged, ^
                  personalUserTokensEnabled } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}"
}'
    "$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 = "query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}";
$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" : "query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}"
}'''

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" : "query {
  clusterConfig { clusterId, 
                  isExternalManaged,
                  personalUserTokensEnabled }
}"
}
);


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": {
    "clusterConfig": {
      "clusterId": "123",
      "isExternalManaged": "false",
      "personalUserTokensEnabled": "true"
    }
  }
}

Returned Values

For the results, there are a few returned values possible. They mostly involve what's enabled and permitted. Your choices are listed below along with descriptions of each:

Table: ClusterConfig 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: Jun 23, 2026
allowActionsNotUseProxybooleanyes Long-TermWhether to allow actions not using proxy (i.e., value of HTTP_PROXY_ALLOW_ACTIONS_NOT_USE).
awsRegions[string]yes Long-TermA list of supported AWS regions.
clusterIdstringyes Long-TermThe unique identifier of the cluster.
deleteBackupAfterlongyes Long-TermThe time in milliseconds after which a repository has been marked for deletion and will no longer be restorable.
externalGroupSynchronizationbooleanyes Short-TermWhether external group synchronization is enabled.
externalPermissionsbooleanyes Long-TermWhether there are external permissions.
falconDataConnectorUrlstring  Short-TermThe URL of the Falcon data connector.
globalAllowListEmailActionsEnabledbooleanyes Long-TermWhether the global allow list email actions are enabled.
ingestFeedAwsRoleArnstring  Long-TermCluster AWS IAM role arn (Amazon Resource Name) used to assume role for ingest feeds.
ingestFeedConfigurationsIngestFeedConfigurationyes Long-TermShows the current configuration for ingest feeds. See IngestFeedConfiguration.
isApiExplorerEnabledbooleanyes Short-TermWhether the API Explorer is enabled.
isAutomaticUpdateCheckingEnabledbooleanyes Long-TermWhether automatic update checking enabled.
isClusterBeingUpdatedbooleanyes Short-TermAn indication whether or not the cluster is being updated. This is based off of differences in the cluster node versions.
isExternalManagedbooleanyes Short-TermWhether the account is externally managed.
isFeatureFlagEnabled(feature: FeatureFlag!): booleanmultiple  Short-TermReturns enabled features that are likely in beta. See FeatureFlag.
isScheduledReportEnabledbooleanyes Short-TermWhether the scheduled report is enabled.
isUsingSmtpbooleanyes Long-TermWhether LogScale is using SMTP.
maxCsvFileUploadSizeByteslongyes Short-TermThe maximum CSV (i.e., comma-separated values) file upload size in bytes.
maxJsonFileUploadSizeByteslongyes Short-TermThe maximum JSON (i.e., JavaScript Object Notation) file upload size in bytes.
minimumNodeVersionstringyes Short-TermThe lowest detected node version in the cluster.
personalUserTokensEnabledbooleanyes Short-TermWhether the personal user tokens are enabled.
sandboxesEnabledbooleanyes Short-TermWhether sandbox repositories are enabled.
scheduledSearchMaxBackfillLimitinteger  Long-TermThe scheduled search maximum backfill limit (i.e., value of SCHEDULED_SEARCH_BACKFILL_LIMIT).
sharedDashboardsEnabledbooleanyes Short-TermWhether the shared dashboards are enabled.
versionstringyes Long-TermThe version of Falcon LogScale.