Skip to content

JSON Schema Grafana

Properties

PropertyTypeRequiredDescription
alerting_enabledbooleanno
alerting_error_or_timeoutstringnoAllowed values: alerting, keep_state.
alerting_max_annotations_to_keepintegernoMin: 0. Max: 1e+06.
alerting_nodata_or_nullvaluesstringnoAllowed values: alerting, no_data, keep_state, ok.
allow_embeddingbooleanno
auth_azureadAuth Azureadno
auth_basic_enabledbooleanno
auth_generic_oauthAuth Generic Oauthno
auth_githubAuth Githubno
auth_gitlabAuth Gitlabno
auth_googleAuth Googleno
cookie_samesitestringnoAllowed values: lax, strict, none.
custom_domainstringnoServe the web frontend using a custom CNAME pointing to the Aiven DNS name

Max length: 255.
dashboard_previews_enabledbooleannoThis feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering.
dashboards_min_refresh_intervalstringnoSigned sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h

Max length: 16.
dashboards_versions_to_keepintegernoMin: 1. Max: 100.
dataproxy_send_user_headerbooleanno
dataproxy_timeoutintegernoMin: 15. Max: 90.
date_formatsDate Formatsno
disable_gravatarbooleanno
editors_can_adminbooleanno
google_analytics_ua_idstringnoMax length: 64.
metrics_enabledbooleanno
oauth_allow_insecure_email_lookupbooleanno
service_logbooleannoStore logs for the service so that they are available in the HTTP API and console.
smtp_serverSMTP Serverno
unified_alerting_enabledbooleanno
user_auto_assign_orgbooleanno
user_auto_assign_org_rolestringnoAllowed values: Viewer, Admin, Editor.
viewers_can_editbooleanno
walbooleannoSetting to enable/disable Write-Ahead Logging. The default value is false (disabled).

Auth Azuread

PropertyTypeRequiredDescription
auth_urlstringyesMax length: 2048.
client_idstringyesMax length: 1024.
client_secretstringyesMax length: 1024.
token_urlstringyesMax length: 2048.
allow_sign_upbooleanno
allowed_domainsarray[string]no
allowed_groupsarray[string]no

Auth Github

PropertyTypeRequiredDescription
client_idstringyesMax length: 1024.
client_secretstringyesMax length: 1024.
allow_sign_upbooleanno
allowed_organizationsarray[string]no
auto_loginbooleanno
skip_org_role_syncbooleanno
team_idsarray[integer]no

SMTP Server

PropertyTypeRequiredDescription
from_addressstringyesMax length: 319.
hoststringyesMax length: 255.
portintegeryesMin: 1. Max: 65535.
from_namestringnoMax length: 128.
passwordstringnoMax length: 255.
skip_verifybooleanno
starttls_policystringnoAllowed values: OpportunisticStartTLS, MandatoryStartTLS, NoStartTLS.
usernamestringnoMax length: 255.

Auth Gitlab

PropertyTypeRequiredDescription
allowed_groupsarray[string]yes
client_idstringyesMax length: 1024.
client_secretstringyesMax length: 1024.
allow_sign_upbooleanno
api_urlstringnoMax length: 2048.
auth_urlstringnoMax length: 2048.
token_urlstringnoMax length: 2048.

Date Formats

PropertyTypeRequiredDescription
default_timezonestringnoMax length: 64.
full_datestringnoMax length: 128.
interval_daystringnoMax length: 128.
interval_hourstringnoMax length: 128.
interval_minutestringnoMax length: 128.
interval_monthstringnoMax length: 128.
interval_secondstringnoMax length: 128.
interval_yearstringnoMax length: 128.

Auth Google

PropertyTypeRequiredDescription
allowed_domainsarray[string]yes
client_idstringyesMax length: 1024.
client_secretstringyesMax length: 1024.
allow_sign_upbooleanno

Auth Generic Oauth

PropertyTypeRequiredDescription
api_urlstringyesMax length: 2048.
auth_urlstringyesMax length: 2048.
client_idstringyesMax length: 1024.
client_secretstringyesMax length: 1024.
token_urlstringyesMax length: 2048.
allow_sign_upbooleanno
allowed_domainsarray[string]no
allowed_organizationsarray[string]no
auto_loginbooleanno
namestringnoMax length: 128.
scopesarray[string]no
Last updated on