This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

API Reference@grafana/runtimeGrafanaBootConfig

GrafanaBootConfig class

Signature

export declare class GrafanaBootConfig implements GrafanaConfig 

Import

import { GrafanaBootConfig } from '@grafana/runtime';

Constructors

Constructor Modifiers Description
constructor(options) Constructs a new instance of the GrafanaBootConfig class

Properties

Property Modifiers Type Description
alertingEnabled boolean
alertingErrorOrTimeout string
alertingMinInterval number
alertingNoDataOrNullValues string
allowOrgCreate boolean
appSubUrl string
appUrl string
authProxyEnabled boolean
autoAssignOrg boolean
awsAllowedAuthProviders string[]
awsAssumeRoleEnabled boolean
azure AzureSettings
bootData any
buildInfo BuildInfo
caching {
enabled: boolean;
}
customTheme any
datasources {
[str: string]: DataSourceInstanceSettings;
}
dateFormats SystemDateFormatSettings
defaultDatasource string
disableLoginForm boolean
disableSanitizeHtml boolean
disableUserSignUp boolean
editorsCanAdmin boolean
exploreEnabled boolean
expressionsEnabled boolean
externalUserMngInfo string
externalUserMngLinkName string
externalUserMngLinkUrl string
featureToggles FeatureToggles
http2Enabled boolean
ldapEnabled boolean
licenseInfo LicenseInfo
liveEnabled boolean
loginError any
loginHint any
minRefreshInterval string
navTree any
newPanelTitle string
oauth any
panels {
[key: string]: PanelPluginMeta;
}
passwordHint any
pluginAdminEnabled boolean
pluginAdminExternalManageEnabled boolean
pluginCatalogURL string
pluginsToPreload string[]
rendererAvailable boolean
rendererVersion string
samlEnabled boolean
sentry {
enabled: boolean;
dsn: string;
customEndpoint: string;
sampleRate: number;
}
sigV4AuthEnabled boolean
theme GrafanaTheme
theme2 GrafanaTheme2
verifyEmailEnabled boolean
viewersCanEdit boolean
windowTitlePrefix string

constructor(options)

Constructs a new instance of the GrafanaBootConfig class

Signature

constructor(options: GrafanaBootConfig);

Parameters

Parameter Type Description
options GrafanaBootConfig

alertingEnabled property

Signature

alertingEnabled: boolean;

alertingErrorOrTimeout property

Signature

alertingErrorOrTimeout: string;

alertingMinInterval property

Signature

alertingMinInterval: number;

alertingNoDataOrNullValues property

Signature

alertingNoDataOrNullValues: string;

allowOrgCreate property

Signature

allowOrgCreate: boolean;

appSubUrl property

Signature

appSubUrl: string;

appUrl property

Signature

appUrl: string;

authProxyEnabled property

Signature

authProxyEnabled: boolean;

autoAssignOrg property

Signature

autoAssignOrg: boolean;

awsAllowedAuthProviders property

Signature

awsAllowedAuthProviders: string[];

awsAssumeRoleEnabled property

Signature

awsAssumeRoleEnabled: boolean;

azure property

Signature

azure: AzureSettings;

bootData property

Signature

bootData: any;

buildInfo property

Signature

buildInfo: BuildInfo;

caching property

Signature

caching: {
        enabled: boolean;
    };

customTheme property

Signature

customTheme?: any;

datasources property

Signature

datasources: {
        [str: string]: DataSourceInstanceSettings;
    };

dateFormats property

Signature

dateFormats?: SystemDateFormatSettings;

defaultDatasource property

Signature

defaultDatasource: string;

disableLoginForm property

Signature

disableLoginForm: boolean;

disableSanitizeHtml property

Signature

disableSanitizeHtml: boolean;

disableUserSignUp property

Signature

disableUserSignUp: boolean;

editorsCanAdmin property

Signature

editorsCanAdmin: boolean;

exploreEnabled property

Signature

exploreEnabled: boolean;

expressionsEnabled property

Signature

expressionsEnabled: boolean;

externalUserMngInfo property

Signature

externalUserMngInfo: string;

externalUserMngLinkName property

Signature

externalUserMngLinkName: string;

externalUserMngLinkUrl property

Signature

externalUserMngLinkUrl: string;

featureToggles property

Signature

featureToggles: FeatureToggles;

http2Enabled property

Signature

http2Enabled: boolean;

ldapEnabled property

Signature

ldapEnabled: boolean;

licenseInfo property

Signature

licenseInfo: LicenseInfo;

liveEnabled property

Signature

liveEnabled: boolean;

loginError property

Signature

loginError: any;

loginHint property

Signature

loginHint: any;

minRefreshInterval property

Signature

minRefreshInterval: string;

Signature

navTree: any;

newPanelTitle property

Signature

newPanelTitle: string;

oauth property

Signature

oauth: any;

panels property

Signature

panels: {
        [key: string]: PanelPluginMeta;
    };

passwordHint property

Signature

passwordHint: any;

pluginAdminEnabled property

Signature

pluginAdminEnabled: boolean;

pluginAdminExternalManageEnabled property

Signature

pluginAdminExternalManageEnabled: boolean;

pluginCatalogURL property

Signature

pluginCatalogURL: string;

pluginsToPreload property

Signature

pluginsToPreload: string[];

rendererAvailable property

Signature

rendererAvailable: boolean;

rendererVersion property

Signature

rendererVersion: string;

samlEnabled property

Signature

samlEnabled: boolean;

sentry property

Signature

sentry: {
        enabled: boolean;
        dsn: string;
        customEndpoint: string;
        sampleRate: number;
    };

sigV4AuthEnabled property

Signature

sigV4AuthEnabled: boolean;

theme property

Signature

theme: GrafanaTheme;

theme2 property

Signature

theme2: GrafanaTheme2;

verifyEmailEnabled property

Signature

verifyEmailEnabled: boolean;

viewersCanEdit property

Signature

viewersCanEdit: boolean;

windowTitlePrefix property

Signature

windowTitlePrefix: string;