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.
DataSourceSettings interface
Data Source instance edit model. This is returned from: /api/datasources
Signature
export interface DataSourceSettings<T extends DataSourceJsonData = DataSourceJsonData, S = {}>
Import
import { DataSourceSettings } from '@grafana/data';
Properties
Property | Type | Description |
---|---|---|
access | string | |
basicAuth | boolean | |
basicAuthPassword | string | |
basicAuthUser | string | |
database | string | |
id | number | |
isDefault | boolean | |
jsonData | T | |
name | string | |
orgId | number | |
password | string | |
readOnly | boolean | |
secureJsonData | S | |
secureJsonFields | KeyValue<boolean> | |
type | string | |
typeLogoUrl | string | |
typeName | string | |
uid | string | |
url | string | |
user | string | |
version | number | |
withCredentials | boolean |
access property
Signature
access: string;
basicAuth property
Signature
basicAuth: boolean;
basicAuthPassword property
Signature
basicAuthPassword: string;
basicAuthUser property
Signature
basicAuthUser: string;
database property
Signature
database: string;
id property
Signature
id: number;
isDefault property
Signature
isDefault: boolean;
jsonData property
Signature
jsonData: T;
name property
Signature
name: string;
orgId property
Signature
orgId: number;
password property
Signature
password: string;
readOnly property
Signature
readOnly: boolean;
secureJsonData property
Signature
secureJsonData?: S;
secureJsonFields property
Signature
secureJsonFields: KeyValue<boolean>;
type property
Signature
type: string;
typeLogoUrl property
Signature
typeLogoUrl: string;
typeName property
Signature
typeName: string;
uid property
Signature
uid: string;
url property
Signature
url: string;
user property
Signature
user: string;
version property
Signature
version?: number;
withCredentials property
Signature
withCredentials: boolean;