Menu

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.

Enterprise Open source

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
export interface DataSourceInstanceSettings<T extends DataSourceJsonData = DataSourceJsonData> 

Import

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

Properties

PropertyTypeDescription
access‘direct’ | ‘proxy’
basicAuthstringThis 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.
databasestring
idnumber
isDefaultboolean
jsonDataT
metaDataSourcePluginMeta
namestring
passwordstring
rawRefDataSourceRefWhen the name+uid are based on template variables, maintain access to the real values
typestring
uidstring
urlstring
usernamestring
withCredentialsboolean

access property

Signature

typescript
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

typescript
basicAuth?: string;

database property

Signature

typescript
database?: string;

id property

Signature

typescript
id: number;

isDefault property

Signature

typescript
isDefault?: boolean;

jsonData property

Signature

typescript
jsonData: T;

meta property

Signature

typescript
meta: DataSourcePluginMeta;

name property

Signature

typescript
name: string;

password property

Signature

typescript
password?: string;

rawRef property

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

Signature

typescript
rawRef?: DataSourceRef;

type property

Signature

typescript
type: string;

uid property

Signature

typescript
uid: string;

url property

Signature

typescript
url?: string;

username property

Signature

typescript
username?: string;

withCredentials property

Signature

typescript
withCredentials?: boolean;