Update a DBaaS Grafana service
Path parameters
-
Service name
Minimum length is
0
, maximum length is63
.
Body Required
-
maintenance object
Automatic maintenance settings
Additional properties are allowed.
-
plan string
Subscription plan
Minimum length is
1
, maximum length is128
. -
termination-protection boolean
Service is protected against termination and powering off
-
grafana-settings object
Grafana specific settings
Additional properties are allowed.
-
ip-filter array[string]
Allowed CIDR address blocks for incoming connections
PUT /dbaas-grafana/{name}
curl \
-X PUT https://api-ch-gva-2.exoscale.com/v2/dbaas-grafana/{name} \
-H "Content-Type: application/json" \
-d '{"maintenance":{"dow":"saturday","time":"string"},"plan":"string","termination-protection":true,"grafana-settings":{"allow_embedding":false,"cookie_samesite":"lax","dashboard_previews_enabled":false,"metrics_enabled":true,"auth_azuread":{"allow_sign_up":false,"allowed_domains":["mycompany.com"],"allowed_groups":["c0ffee15-c01d-0000-1111-012345abcdef"],"auth_url":"https://login.microsoftonline.com/\u003cAZURE_TENANT_ID\u003e/oauth2/v2.0/authorize","client_id":"b1ba0bf54a4c2c0a1c29","client_secret":"bfa6gea4f129076761dcba8ce5e1e406bd83af7b","token_url":"https://login.microsoftonline.com/\u003cAZURE_TENANT_ID\u003e/oauth2/v2.0/token"},"alerting_enabled":true,"unified_alerting_enabled":true,"auth_github":{"allow_sign_up":false,"allowed_organizations":["aiven"],"auto_login":false,"client_id":"b1ba0bf54a4c2c0a1c29","client_secret":"bfa6gea4f129076761dcba8ce5e1e406bd83af7b","skip_org_role_sync":false,"team_ids":[150]},"user_auto_assign_org":false,"dataproxy_send_user_header":false,"google_analytics_ua_id":"UA-123456-4","dashboards_versions_to_keep":20,"editors_can_admin":false,"smtp_server":{"from_address":"yourgrafanauser@yourdomain.example.com","from_name":"Company Grafana","host":"smtp.example.com","password":"ein0eemeev5eeth3Ahfu","port":25,"skip_verify":"false","starttls_policy":"NoStartTLS","username":"smtpuser"},"auth_gitlab":{"allow_sign_up":false,"allowed_groups":["aiven/developers"],"api_url":"https://gitlab.com/api/v4","auth_url":"https://gitlab.com/oauth/authorize","client_id":"b1ba0bf54a4c2c0a1c29","client_secret":"bfa6gea4f129076761dcba8ce5e1e406bd83af7b","token_url":"https://gitlab.com/oauth/token"},"alerting_nodata_or_nullvalues":"ok","auth_basic_enabled":true,"date_formats":{"default_timezone":"Europe/Helsinki","full_date":"YYYY MM DD","interval_day":"MM/DD","interval_hour":"MM/DD HH:mm","interval_minute":"HH:mm","interval_month":"YYYY-MM","interval_second":"HH:mm:ss","interval_year":"YYYY"},"service_log":true,"disable_gravatar":false,"user_auto_assign_org_role":"Viewer","dataproxy_timeout":30,"viewers_can_edit":false,"dashboards_min_refresh_interval":"5s","auth_google":{"allow_sign_up":false,"allowed_domains":["example.com"],"client_id":"b1ba0bf54a4c2c0a1c29","client_secret":"bfa6gea4f129076761dcba8ce5e1e406bd83af7b"},"oauth_allow_insecure_email_lookup":false,"alerting_max_annotations_to_keep":0,"auth_generic_oauth":{"scopes":["email"],"allowed_domains":["mycompany.com"],"allowed_organizations":["myorg"],"token_url":"https://yourprovider.com/oauth/token","name":"My authentication","auth_url":"https://yourprovider.com/oauth/authorize","api_url":"https://yourprovider.com/api","auto_login":false,"client_id":"b1ba0bf54a4c2c0a1c29","client_secret":"bfa6gea4f129076761dcba8ce5e1e406bd83af7b","allow_sign_up":false},"alerting_error_or_timeout":"alerting"},"ip-filter":["string"]}'
Request examples
{
"maintenance": {
"dow": "saturday",
"time": "string"
},
"plan": "string",
"termination-protection": true,
"grafana-settings": {
"allow_embedding": false,
"cookie_samesite": "lax",
"dashboard_previews_enabled": false,
"metrics_enabled": true,
"auth_azuread": {
"allow_sign_up": false,
"allowed_domains": [
"mycompany.com"
],
"allowed_groups": [
"c0ffee15-c01d-0000-1111-012345abcdef"
],
"auth_url": "https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize",
"client_id": "b1ba0bf54a4c2c0a1c29",
"client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
"token_url": "https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token"
},
"alerting_enabled": true,
"unified_alerting_enabled": true,
"auth_github": {
"allow_sign_up": false,
"allowed_organizations": [
"aiven"
],
"auto_login": false,
"client_id": "b1ba0bf54a4c2c0a1c29",
"client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
"skip_org_role_sync": false,
"team_ids": [
150
]
},
"user_auto_assign_org": false,
"dataproxy_send_user_header": false,
"google_analytics_ua_id": "UA-123456-4",
"dashboards_versions_to_keep": 20,
"editors_can_admin": false,
"smtp_server": {
"from_address": "yourgrafanauser@yourdomain.example.com",
"from_name": "Company Grafana",
"host": "smtp.example.com",
"password": "ein0eemeev5eeth3Ahfu",
"port": 25,
"skip_verify": "false",
"starttls_policy": "NoStartTLS",
"username": "smtpuser"
},
"auth_gitlab": {
"allow_sign_up": false,
"allowed_groups": [
"aiven/developers"
],
"api_url": "https://gitlab.com/api/v4",
"auth_url": "https://gitlab.com/oauth/authorize",
"client_id": "b1ba0bf54a4c2c0a1c29",
"client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
"token_url": "https://gitlab.com/oauth/token"
},
"alerting_nodata_or_nullvalues": "ok",
"auth_basic_enabled": true,
"date_formats": {
"default_timezone": "Europe/Helsinki",
"full_date": "YYYY MM DD",
"interval_day": "MM/DD",
"interval_hour": "MM/DD HH:mm",
"interval_minute": "HH:mm",
"interval_month": "YYYY-MM",
"interval_second": "HH:mm:ss",
"interval_year": "YYYY"
},
"service_log": true,
"disable_gravatar": false,
"user_auto_assign_org_role": "Viewer",
"dataproxy_timeout": 30,
"viewers_can_edit": false,
"dashboards_min_refresh_interval": "5s",
"auth_google": {
"allow_sign_up": false,
"allowed_domains": [
"example.com"
],
"client_id": "b1ba0bf54a4c2c0a1c29",
"client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b"
},
"oauth_allow_insecure_email_lookup": false,
"alerting_max_annotations_to_keep": 0,
"auth_generic_oauth": {
"scopes": [
"email"
],
"allowed_domains": [
"mycompany.com"
],
"allowed_organizations": [
"myorg"
],
"token_url": "https://yourprovider.com/oauth/token",
"name": "My authentication",
"auth_url": "https://yourprovider.com/oauth/authorize",
"api_url": "https://yourprovider.com/api",
"auto_login": false,
"client_id": "b1ba0bf54a4c2c0a1c29",
"client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
"allow_sign_up": false
},
"alerting_error_or_timeout": "alerting"
},
"ip-filter": [
"string"
]
}
Response examples (200)
{
"id": "string",
"reason": "incorrect",
"reference": {
"id": "string",
"link": "string",
"command": "string"
},
"message": "string",
"state": "failure"
}