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.

Grafana documentation API Reference @grafana/data DataSourceSettings

DataSourceSettings interface

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

Signature

typescript Copy

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

Import

typescript Copy

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

Properties

access property

Signature

typescript Copy

access: string;

basicAuth property

Signature

typescript Copy

basicAuth: boolean;

basicAuthPassword property

Signature

typescript Copy

basicAuthPassword: string;

basicAuthUser property

Signature

typescript Copy

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

name property

Signature

typescript Copy

name: string;

orgId property

Signature

typescript Copy

orgId: number;

password property

Signature

typescript Copy

password: string;

readOnly property

Signature

typescript Copy

readOnly: boolean;

secureJsonData property

Signature

typescript Copy

secureJsonData?: S;

secureJsonFields property

Signature

typescript Copy

secureJsonFields: KeyValue<boolean>;

type property

Signature

typescript Copy

type: string;

typeLogoUrl property

Signature

typescript Copy

typeLogoUrl: string;

typeName property

Signature

typescript Copy

typeName: string;

uid property

Signature

typescript Copy

uid: string;

url property

Signature

typescript Copy

url: string;

user property

Signature

typescript Copy

user: string;

version property

Signature

typescript Copy

version?: number;

withCredentials property

Signature

typescript Copy

withCredentials: boolean;