Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation API Reference @grafana/data DataSourceInstanceSettings

DataSourceInstanceSettings interface

Frontend settings model that is passed to Datasource constructor. This differs a bit from the model above as this data model is available to every user who has access to a data source (Viewers+). This is loaded in bootData (on page load), or from: /api/frontend/settings

Signature

typescript Copy

export interface DataSourceInstanceSettings<T extends DataSourceJsonData = DataSourceJsonData> 

Import

typescript Copy

import { DataSourceInstanceSettings } from '@grafana/data';

Properties

basicAuth property

This is the full Authorization header if basic auth is enabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposed to browser/Frontend so this will be empty then.

Signature

typescript Copy

basicAuth?: string;

database property

Signature

typescript Copy

database?: string;

id property

Signature

typescript Copy

id: number;

isDefault property

Signature

typescript Copy

isDefault?: boolean;

jsonData property

Signature

typescript Copy

jsonData: T;

meta property

Signature

typescript Copy

meta: DataSourcePluginMeta;

name property

Signature

typescript Copy

name: string;

password property

Signature

typescript Copy

password?: string;

type property

Signature

typescript Copy

type: string;

uid property

Signature

typescript Copy

uid: string;

url property

Signature

typescript Copy

url?: string;

username property

Signature

typescript Copy

username?: string;

withCredentials property

Signature

typescript Copy

withCredentials?: boolean;