API Stability Short-Term

The environmentVariableUsage() GraphQL query is used to get usage information about non-secret environment variables.

Syntax

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

graphql
environmentVariableUsage: [EnvironmentVariableUsage!]!

This query is simple. You enter the parameters you want returned, as you can see in the example below:

Show:
graphql
query {
  environmentVariableUsage {name, source, value}
}
Example Responses
Show:
json
{
  "data": {
    "environmentVariableUsage": [
      {
        "name": "S3_STORAGE_CHUNK_SIZE",
        "source": "Default",
        "value": "*****"
      },
      {
        "name": "TLS_KEY_PASSWORD",
        "source": "Missing",
        "value": "*****"
      },
      {
        "name": "HUMIO_GITHUB_DEMO",
        "source": "Default",
        "value": "*****"
      },
      {
        "name": "EMERGENCY_USERS",
        "source": "Default",
        "value": "*****"
      },
      {
        "name": "INGEST_FEED_GOVERNOR_INITIAL_RATE_PER_CORE",
        "source": "Default",
        "value": "*****"
      },
      ...
    ]
  }
}

Since the results are very long, they've been shortened here to save space.

Returned Datatypes

The environmentVariableUsage datatype has only a few parameters. They're listed below:

Table: EnvironmentVariableUsage

ParameterTypeRequiredDefaultStabilityDescription
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 24, 2024
namestringyes Short-TermThe environment variable name.
sourcestringyes Short-TermThe source for the environment variable. Environment: The value is from the environment, Default: variable not found in the environment, but a default value is used. Missing: no variable or default found.
valuestringyes Short-TermThe value for this variable.