🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The clusterConfig() GraphQL query returns configuration and identity information about the cluster. Requires authentication. This query returns the cluster version, cluster ID, AWS configuration, feature flag states, external permissions setting, and update status.

Syntax

graphql
clusterConfig(): ClusterConfig!

There is no input for this query. Specify the configuration fields you want returned, such as the cluster version, cluster ID, or AWS regions. See Returned Values 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

The ClusterConfig datatype provides the cluster version (version) and cluster identifier (clusterId), whether external permissions are enabled (externalPermissions), AWS configuration (awsRegions, ingestFeedAwsRoleArn), update status (isClusterBeingUpdated, minimumNodeVersion), feature flag state (isFeatureFlagEnabled), and the Falcon Data Connector URL (falconDataConnectorUrl, nullable). The available fields are listed here:

Table: ClusterConfig Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowActionsNotUseProxyBooleanyes Long-Term Whether to allow actions not using proxy (i.e., value of HTTP_PROXY_ALLOW_ACTIONS_NOT_USE).
awsRegionsStringyes Long-Term A list of supported AWS regions.
clusterIdStringyes Long-Term The unique identifier of the cluster.
deleteBackupAfterLongyes Long-Term The time in milliseconds after which a repository has been marked for deletion and will no longer be restorable.
externalGroupSynchronizationBooleanyes Short-Term Whether external group synchronization is enabled.
externalPermissionsBooleanyes Long-Term Whether there are external permissions.
falconDataConnectorUrlString  Short-Term The URL of the Falcon data connector.
globalAllowListEmailActionsEnabledBooleanyes Long-Term Whether the global allow list email actions are enabled.
ingestFeedAwsRoleArnString  Long-Term Cluster AWS IAM role arn (Amazon Resource Name) used to assume role for ingest feeds.
ingestFeedConfigurationsIngestFeedConfigurationyes Long-Term Shows the current configuration for ingest feeds.
isApiExplorerEnabledBooleanyes Short-Term Whether the API Explorer is enabled.
isAutomaticUpdateCheckingEnabledBooleanyes Long-Term Whether automatic update checking enabled.
isClusterBeingUpdatedBooleanyes Short-Term An indication whether or not the cluster is being updated. This is based off of differences in the cluster node versions.
isExternalManagedBooleanyes Short-Term Whether the account is externally managed.
isFeatureFlagEnabled(feature: FeatureFlag!)Booleanyes Short-Term Returns enabled features that are likely in beta. See FeatureFlag.
isScheduledReportEnabledBooleanyes Short-Term Whether the scheduled report is enabled.
isUsingSmtpBooleanyes Long-Term Whether LogScale is using SMTP.
maxCsvFileUploadSizeBytesLongyes Short-Term The maximum CSV (i.e., comma-separated values) file upload size in bytes.
maxJsonFileUploadSizeBytesLongyes Short-Term The maximum JSON (i.e., JavaScript Object Notation) file upload size in bytes.
minimumNodeVersionStringyes Short-Term The lowest detected node version in the cluster.
personalUserTokensEnabledBooleanyes Short-Term Whether the personal user tokens are enabled.
sandboxesEnabledBooleanyes Short-Term  
scheduledSearchMaxBackfillLimitInt  Long-Term The scheduled search maximum backfill limit (i.e., value of SCHEDULED_SEARCH_BACKFILL_LIMIT).
sharedDashboardsEnabledBooleanyes Short-Term Whether the shared dashboards are enabled.
versionStringyes Long-Term The version of Falcon LogScale.