Environment variables type

Use the environment variables object type to define environment variables for your apps in your app's manifest file.

The environment variables object is not an IBM® QRadar® application type. The following four environment variables are set automatically by QRadar and are available to use in your app.

QRADAR_CONSOLE_HOST_NAME

The host name of the console where the app is installed.

QRADAR_CONSOLE_IP

The IP address of where the app is installed.

QRADAR_APPLICATION_BASE_URL

The web URL for the app.

LANG

The language code and character encoding that is used by the QRadar Console UI when the app is installed.

HTTP_PROXY / HTTPS_PROXY

If a proxy is configured, this environment variable is the IP address/hostname of the proxy server that QRadar uses.

PROXY_USERNAME

If a proxy is configured, this environment variable is the username of the HTTPS proxy server that QRadar uses.

PROXY_PASSWORD_DECRYPTED

If a proxy is configured, this environment variable is the decrypted password of the HTTPS proxy server that QRadar uses.

PROXY_URL

If a proxy is configured, this environment variable is the IP address/hostname of the proxy server that QRadar uses.

PROXY_PORT

If a proxy is configured, this environment variable is the port number of the proxy server that QRadar uses.

Environment variables that you define in an app's manifest file are specific to that app and haven no effect outside the app container.

The following code sample shows how to configure the environment_variables block in the manifest file.

{
...
"environment_variables":[
		{
               "name":"ENV_VAR1",
               "value":"1"
		},
		{ 
               "name":"ENV_VAR2",
               "value":"2"
		},
		{
                "name":"ENV_VAR3",
                "value":"3"
		}
	],

...
}

The following table explains the manifest fields for the environment_variables block.