API Reference@grafana/dataDataSourceInstanceSettings

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

export interface DataSourceInstanceSettings<T extends DataSourceJsonData = DataSourceJsonData> 

Import

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

Properties

Property Type Description
access ‘direct’ | ‘proxy’
basicAuth string 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.
database string
id number
isDefault boolean
jsonData T
meta DataSourcePluginMeta
name string
password string
rawRef DataSourceRef When the name+uid are based on template variables, maintain access to the real values
type string
uid string
url string
username string
withCredentials boolean

access property

Signature

access: 'direct' | 'proxy';

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

basicAuth?: string;

database property

Signature

database?: string;

id property

Signature

id: number;

isDefault property

Signature

isDefault?: boolean;

jsonData property

Signature

jsonData: T;

meta property

Signature

meta: DataSourcePluginMeta;

name property

Signature

name: string;

password property

Signature

password?: string;

rawRef property

When the name+uid are based on template variables, maintain access to the real values

Signature

rawRef?: DataSourceRef;

type property

Signature

type: string;

uid property

Signature

uid: string;

url property

Signature

url?: string;

username property

Signature

username?: string;

withCredentials property

Signature

withCredentials?: boolean;