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
DataSourceSettings interface
Data Source instance edit model. This is returned from: /api/datasources
Signature
typescript
export interface DataSourceSettings<T extends DataSourceJsonData = DataSourceJsonData, S = {}>
Import
typescript
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
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;
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:

Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.

Getting started with Grafana dashboard design (EMEA Timezone)
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.

Unify your data with Grafana plugins: Datadog, Splunk, MongoDB, and more
In this webinar, learn how to leverage Grafana's plugin ecosystem for access to 80+ data sources, including plugins for Datadog, Splunk, MongoDB, and more.