meta()

API Stability	`Short-Term`

The meta() GraphQL query will return information about the LogScale instance.

For information on clusters, see the Cluster Management documentation page. You may also want to look at the LogScale Logical Architecture page in the Training section.

Syntax

Below is the syntax for the meta() query field:

graphql

meta(url: string): HumioMetadata!

This query field has one input, the URL of the LogScale instance. For the results, though, there are many parameters that may be given within curly-brackets. Below is an example:

Show:

graphql

query {
  meta(url: "https://logger.company.com") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  meta(url: \"https://logger.company.com\")  ^
     {version, organizationMode, ^
      authenticationMethod{name},  ^
      sharedDashboardsEnabled,  ^
      environment,  isExternalManaged ^
    } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}'''

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

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}
);


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

Show:

json

{
  "data": {
    "meta": {
      "authenticationMethod": {
        "name": "SAMLAuthentication"
      },
      "sharedDashboardsEnabled": true,
      "organizationMode": "Single",
      "version": "1.161.0--build-2112--sha-ea4237e6b99165389c673adff40050178f1a697e",
      "isExternalManaged": false,
      "environment": "ON_PREM"
    }
  }
}

See the Returned Datatypes section for the parameters that are allowed.

Returned Datatypes

For HumioMetadata there are several parameters that may be given. Below is a list of them along with a description of each:

Table: HumioMetadata

Parameter	Type	Required	Stability	Description
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: Mar 26, 2025
`allowActionsNotUseProxy`	boolean	yes	`Long-Term`	Whether to allow actions not using proxy (i.e., value of `HTTP_PROXY_ALLOW_ACTIONS_NOT_USE`).
`authenticationMethod`	`AuthenticationMethod`	yes	`Long-Term`	The authentication method used for the cluster node. See `AuthenticationMethod`.
`awsIngestFeedsConfigurationStatus`	`IngestFeedConfigurationStatus`	yes	`Long-Term`	The configuration status for AWS ingest feeds. This is a preview, an experimental feature. It's not ready for production. See `IngestFeedConfigurationStatus`.
`awsRegions`	[string]	yes	`Long-Term`	A list of supported AWS regions. This is a preview, an experimental feature. It's not ready for production.
`clusterId`	string	yes	`Long-Term`	The unique identifier of the cluster.
`deleteBackupAfter`	long	yes	`Long-Term`	The time in ms after which a repository has been marked for deletion it will no longer be restorable.
`environment`	`EnvironmentType`	yes	`Long-Term`	The type of environment on which LogScale is running. See `EnvironmentType`.
`eulaUrl`	string	yes	`Short-Term`	The URL for where the End-User License Agreement can be found.
`externalGroupSynchronization`	boolean	yes	`Short-Term`	Whether external group synchronization is enabled.
`externalPermissions`	boolean	yes	`Long-Term`	Whether there are external permissions.
`falconDataConnectorUrl`	string		`Short-Term`	The URL of the Falcon data connector.
`filterAlertConfig`	`FilterAlertConfig`	yes	`Deprecated`	The configuration for filter alerts. See `FilterAlertConfig`. This is deprecated. It's no longer used internally. It will be removed in version 1.189.
`globalAllowListEmailActionsEnabled`	boolean	yes	`Long-Term`	Whether the global allow list email actions are enabled.
`ingestFeedAwsRoleArn`	string		`Long-Term`	Cluster AWS IAM role arn (i.e., Amazon Resource Name) used to assume role for ingest feeds. This is a preview, an experimental feature. It's not ready for production.
`isApiExplorerEnabled`	boolean	yes	`Short-Term`	Whether the API Explorer is enabled.
`isAutomaticUpdateCheckingEnabled`	boolean	yes	`Long-Term`	Whether automatic update checking enabled.
`isClusterBeingUpdated`	boolean	yes	`Preview`	Whether the cluster is being updated, based on differences in the cluster node versions. This is a preview, an experimental field used to improve the user experience during cluster upgrades.
`isExternalManaged`	boolean	yes	`Short-Term`	Whether the account is externally managed.
`isFeatureFlagEnabled`	multiple	yes	`Short-Term`	Returns enabled features that are likely in beta. The syntax for the datatype is `(feature: FeatureFlag): boolean`. See `FeatureFlag`.
`isPendingUsersEnabled`	boolean	yes	`Short-Term`	Whether allowing pending users is enabled.
`isScheduledReportEnabled`	boolean	yes	`Short-Term`	Whether the scheduled r eport is enabled.
`isUsingSmtp`	boolean	yes	`Long-Term`	Whether LogScale is using SMTP.
`maxCsvFileUploadSizeBytes`	long	yes	`Short-Term`	The maximum CSV (i.e., comma-separated values) file upload size in bytes.
`maxJsonFileUploadSizeBytes`	long	yes	`Short-Term`	The maximum JSON (i.e., JavaScript Object Notation) file upload size in bytes.
`minimumNodeVersion`	string	yes	`Preview`	The lowest detected node version in the cluster. This is a preview, an experimental field used to improve the user experience during cluster upgrades.
`organizationMode`	`OrganizationMode`	yes	`Short-Term`	Whether the organization mode used. See `OrganizationMode`.
`organizationMultiMode`	boolean	yes	`Short-Term`	Whether the organization is using multi-mode.
`personalUserTokensEnabled`	boolean	yes	`Short-Term`	Whether the personal user tokens are enabled.
`regions`	[`RegionSelectData`]	yes	`Long-Term`	The name and URL for the regions. See `RegionSelectData`.
`sandboxesEnabled`	boolean	yes	`Short-Term`	Whether sandbox repositories are enabled.
`scheduledSearchMaxBackfillLimit`	integer		`Long-Term`	The scheduled search maximum backfill limit (i.e., value of `SCHEDULED_SEARCH_BACKFILL_LIMIT`).
`sharedDashboardsEnabled`	boolean	yes	`Short-Term`	Whether the shared dashboards are enabled.
`version`	string	yes	`Long-Term`	The version of Falcon LogScale.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes

meta()

Syntax

Returned Datatypes

Enter search term