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.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/databreadcrumb arrow DataSourceSettings
Enterprise Open source

DataSourceSettings interface

Data Source instance edit model. This is returned from: /api/datasources

Signature

typescript 
export interface DataSourceSettings<T extends DataSourceJsonData = DataSourceJsonData, S = {}> extends WithAccessControlMetadata

Import

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

Properties

PropertyTypeDescription
accessstring
basicAuthboolean
basicAuthPasswordstring
basicAuthUserstring
databasestring
idnumber
isDefaultboolean
jsonDataT
namestring
orgIdnumber
passwordstring
readOnlyboolean
secureJsonDataS
secureJsonFieldsKeyValue<boolean>
typestring
typeLogoUrlstring
typeNamestring
uidstring
urlstring
userstring
versionnumber
withCredentialsboolean

access property

Signature

typescript 
access: string;

basicAuth property

Signature

typescript 
basicAuth: boolean;

basicAuthPassword property

Signature

typescript 
basicAuthPassword: string;

basicAuthUser property

Signature

typescript 
basicAuthUser: 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;

name property

Signature

typescript 
name: string;

orgId property

Signature

typescript 
orgId: number;

password property

Signature

typescript 
password: string;

readOnly property

Signature

typescript 
readOnly: boolean;

secureJsonData property

Signature

typescript 
secureJsonData?: S;

secureJsonFields property

Signature

typescript 
secureJsonFields: KeyValue<boolean>;

type property

Signature

typescript 
type: string;

typeLogoUrl property

Signature

typescript 
typeLogoUrl: string;

typeName property

Signature

typescript 
typeName: string;

uid property

Signature

typescript 
uid: string;

url property

Signature

typescript 
url: string;

user property

Signature

typescript 
user: string;

version property

Signature

typescript 
version?: number;

withCredentials property

Signature

typescript 
withCredentials: boolean;