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:

Raw
graphql
query {
  meta(url: "https://logger.company.com") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}
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 {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}
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 {
  meta(url: \"https://logger.company.com\") 
     {version, organizationMode,
      authenticationMethod{name}, 
      sharedDashboardsEnabled, 
      environment,  isExternalManaged
    }
}"
}
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 { ^
  meta(url: \"https://logger.company.com\")  ^
     {version, organizationMode, ^
      authenticationMethod{name},  ^
      sharedDashboardsEnabled,  ^
      environment,  isExternalManaged ^
    } ^
}" ^
} '
Windows Powershell and curl
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
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
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)
Node.js
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
Success (HTTP Response Code 200 OK)
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

ParameterTypeRequiredDefaultDescription
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 25, 2024
allowActionsNotUseProxybooleanyes Whether to allow actions not using proxy (i.e., value of HTTP_PROXY_ALLOW_ACTIONS_NOT_USE).
authenticationMethodAuthenticationMethodyes The authentication method used for the cluster node. See OAuthAuthentication.
awsIngestFeedsConfigurationStatusIngestFeedConfigurationStatusyes 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 A list of supported AWS regions. This is a preview, an experimental feature. It's not ready for production.
clusterIdstringyes The unique identifier of the cluster.
deleteBackupAfterlongyes The time in ms after which a repository has been marked for deletion it will no longer be restorable.
environmentEnvironmentTypeyes The type of environment on which LogScale is running. See EnvironmentType.
eulaUrlstringyes The URL for where the End-User License Agreement can be found.
externalGroupSynchronizationbooleanyes Whether external group synchronization is enabled.
externalPermissionsbooleanyes Whether there are external permissions.
falconDataConnectorUrlstring  The URL of the Falcon data connector.
filesConfigFilesConfigyes The lookup files configuration. See FilesConfig. This is deprecated. Use instead maxCsvFileUploadSizeBytes and maxJsonFileUploadSizeBytes.
filterAlertConfigFilterAlertConfigyes The configuration for filter alerts. See FilterAlertConfig. This is deprecated. It will be removed in version 1.142.
globalAllowListEmailActionsEnabledbooleanyes Whether the global allow list email actions are enabled.
ingestFeedAwsRoleArnstring  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.
isApiExplorerEnabledbooleanyes Whether the API Explorer is enabled.
isAutomaticUpdateCheckingEnabledbooleanyes Whether automatic update checking enabled.
isClusterBeingUpdatedbooleanyes 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.
isExternalManagedbooleanyes Whether the account is externally managed.
isFeatureFlagEnabledmutipleyes Returns enabled features that are likely in beta. The syntax for the datatype is (feature: FeatureFlag): boolean. See FeatureFlag.
isPendingUsersEnabledbooleanyes Whether allowing pending users is enabled.
isScheduledReportEnabledbooleanyes Whether the scheduled r eport is enabled.
isUsingSmtpbooleanyes Whether LogScale is using SMTP.
maxCsvFileUploadSizeByteslongyes The maximum CSV (i.e., comma-separated values) file upload size in bytes.
maxJsonFileUploadSizeByteslongyes The maximum JSON (i.e., JavaScript Object Notation) file upload size in bytes.
minimumNodeVersionstringyes The lowest detected node version in the cluster. This is a preview, an experimental field used to improve the user experience during cluster upgrades.
organizationModeOrganizationModeyes Whether the organization mode used. See OrganizationMode.
organizationMultiModebooleanyes Whether the organization is using multi-mode.
personalUserTokensEnabledbooleanyes Whether the personal user tokens are enabled.
regions[RegionSelectData]yes The name and URL for the regions. See RegionSelectData.
sandboxesEnabledbooleanyes Whether sandbox repositories are enabled.
scheduledSearchMaxBackfillLimitinteger  The scheduled search maximum backfill limit (i.e., value of SCHEDULED_SEARCH_BACKFILL_LIMIT).
sharedDashboardsEnabledbooleanyes Whether the shared dashboards are enabled.
versionstringyes The version of Falcon LogScale.