Update a DBaaS Grafana service

PUT /dbaas-grafana/{name}

Path parameters

name string Required

Service name

Minimum length is 0, maximum length is 63.

application/json

Body Required

maintenance object

Automatic maintenance settings

Additional properties are allowed.
Hide maintenance attributes Show maintenance attributes object
- dow string Required
  
  Day of week for installing updates
  
  Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.
- time string Required
  
  Time for installing updates, UTC
  
  Minimum length is 8, maximum length is 8.
plan string

Subscription plan

Minimum length is 1, maximum length is 128.
termination-protection boolean

Service is protected against termination and powering off
grafana-settings object

Grafana specific settings

Additional properties are allowed.
Hide grafana-settings attributes Show grafana-settings attributes object
- allow_embedding boolean
- cookie_samesite string
  
  Values are lax, strict, or none.
- dashboard_previews_enabled boolean
  
  This 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.
- metrics_enabled boolean
- auth_azuread object
  
  Additional properties are NOT allowed.
  Hide auth_azuread attributes Show auth_azuread attributes object
  
  allow_sign_up boolean
  
  allowed_domains array[string]
  
  Not more than 50 elements. Maximum length of each is 255.
  
  allowed_groups array[string]
  
  Not more than 50 elements. Maximum length of each is 36. Format of each should match the following pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$.
  
  auth_url string Required
  
  Maximum length is 2048.
  
  client_id string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  client_secret string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  token_url string Required
  
  Maximum length is 2048.
- alerting_enabled boolean
- wal boolean
  
  Setting to enable/disable Write-Ahead Logging. The default value is false (disabled).
- unified_alerting_enabled boolean
- auth_github object
  
  Additional properties are NOT allowed.
  Hide auth_github attributes Show auth_github attributes object
  
  allow_sign_up boolean
  
  allowed_organizations array[string]
  
  Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[A-Za-z0-9-]+$.
  
  auto_login boolean
  
  client_id string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  client_secret string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  skip_org_role_sync boolean
  
  team_ids array[integer]
  
  Not more than 50 elements. Minimum value of each is 1, maximum value of each is 9223372036854775807.
- user_auto_assign_org boolean
- dataproxy_send_user_header boolean
- google_analytics_ua_id string
  
  Maximum length is 64. Format should match the following pattern: ^(G|UA|YT|MO)-[a-zA-Z0-9-]+$.
- dashboards_versions_to_keep integer
  
  Minimum value is 1, maximum value is 100.
- editors_can_admin boolean
- smtp_server object
  
  Additional properties are NOT allowed.
  Hide smtp_server attributes Show smtp_server attributes object
  
  from_address string Required
  
  Maximum length is 319. Format should match the following pattern: ^[A-Za-z0-9_\-\.+'&]+@(([\da-zA-Z])([_\w-]{0,62})\.){0,127}(([\da-zA-Z])[_\w-]{0,61})?([\da-zA-Z]\.((xn\-\-[a-zA-Z\d]+)|([a-zA-Z\d]{2,})))$.
  
  from_name string | null
  
  Maximum length is 128. Format should match the following pattern: ^[^\x00-\x1F]+$.
  
  host string Required
  
  Maximum length is 255.
  
  password string | null
  
  Maximum length is 255. Format should match the following pattern: ^[^\x00-\x1F]+$.
  
  port integer Required
  
  Minimum value is 1, maximum value is 65535.
  
  skip_verify boolean
  
  starttls_policy string
  
  Values are OpportunisticStartTLS, MandatoryStartTLS, or NoStartTLS.
  
  username string | null
  
  Maximum length is 255. Format should match the following pattern: ^[^\x00-\x1F]+$.
- auth_gitlab object
  
  Additional properties are NOT allowed.
  Hide auth_gitlab attributes Show auth_gitlab attributes object
  
  allow_sign_up boolean
  
  allowed_groups array[string] Required
  
  Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[a-z0-9-_/]+$.
  
  api_url string
  
  Maximum length is 2048.
  
  auth_url string
  
  Maximum length is 2048.
  
  client_id string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  client_secret string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  token_url string
  
  Maximum length is 2048.
- alerting_nodata_or_nullvalues string
  
  Values are alerting, no_data, keep_state, or ok.
- auth_basic_enabled boolean
- date_formats object
  
  Additional properties are NOT allowed.
  Hide date_formats attributes Show date_formats attributes object
  
  default_timezone string
  
  Maximum length is 64. Format should match the following pattern: ^([a-zA-Z_]+/){1,2}[a-zA-Z_-]+$|^(Etc/)?([Uu][Tt][Cc]|[Gg][Mm][Tt])([+-](\d){1,2})?$|^([Ff][Aa][Cc][Tt][Oo][Rr][Yy])$|^([Bb][Rr][Oo][Ww][Ss][Ee][Rr])$.
  
  full_date string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
  
  interval_day string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
  
  interval_hour string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
  
  interval_minute string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
  
  interval_month string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
  
  interval_second string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
  
  interval_year string
  
  Maximum length is 128. Format should match the following pattern: ^(([Hh]mm(ss)?|Mo|MM?M?M?|Do|DDDo|DD?D?D?|ddd?d?|do?|w[o|w]?|W[o|W]?|Qo?|N{1,5}|YYYYYY|YYYYY|YYYY|YY|y{2,4}|yo?|gg(ggg?)?|GG(GGG?)?|e|E|a|A|hh?|HH?|kk?|mm?|ss?|S{1,9}|x|X|zz?|ZZ?|LTS|LT|LL?L?L?|l{1,4}|[-+/T,;.: ]?)*)$.
- service_log boolean | null
  
  Store logs for the service so that they are available in the HTTP API and console.
- disable_gravatar boolean
- user_auto_assign_org_role string
  
  Values are Viewer, Admin, or Editor.
- dataproxy_timeout integer
  
  Minimum value is 15, maximum value is 90.
- viewers_can_edit boolean
- dashboards_min_refresh_interval string
  
  Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h
  
  Maximum length is 16. Format should match the following pattern: ^[0-9]+(ms|s|m|h|d)$.
- auth_google object
  
  Additional properties are NOT allowed.
  Hide auth_google attributes Show auth_google attributes object
  
  allow_sign_up boolean
  
  allowed_domains array[string] Required
  
  Not more than 64 elements. Maximum length of each is 255.
  
  client_id string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  client_secret string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
- oauth_allow_insecure_email_lookup boolean
- alerting_max_annotations_to_keep integer
  
  Minimum value is 0, maximum value is 1000000.
- auth_generic_oauth object
  
  Additional properties are NOT allowed.
  Hide auth_generic_oauth attributes Show auth_generic_oauth attributes object
  
  scopes array[string]
  
  Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[\S]+$.
  
  allowed_domains array[string]
  
  Not more than 50 elements. Maximum length of each is 255.
  
  allowed_organizations array[string]
  
  Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[\S]+$.
  
  token_url string Required
  
  Maximum length is 2048.
  
  name string
  
  Maximum length is 128. Format should match the following pattern: ^[a-zA-Z0-9_\- ]+$.
  
  auth_url string Required
  
  Maximum length is 2048.
  
  api_url string Required
  
  Maximum length is 2048.
  
  auto_login boolean
  
  client_id string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  client_secret string Required
  
  Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.
  
  allow_sign_up boolean
- custom_domain string | null
  
  Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
  
  Maximum length is 255.
- alerting_error_or_timeout string
  
  Values are alerting or keep_state.
ip-filter array[string]

Allowed CIDR address blocks for incoming connections

Responses

200 application/json

200
Hide response attributes Show response attributes object
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Additional properties are allowed.
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

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,"wal":false,"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},"custom_domain":"grafana.example.org","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,
    "wal": false,
    "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
    },
    "custom_domain": "grafana.example.org",
    "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"
}