Get a DBaaS Grafana service

GET /dbaas-grafana/{name}

Path parameters

  • name dbaas-service-name Required

    Service name

    Minimum length is 0, maximum length is 63.

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes dbaas-service-grafana
    • DbaaS service description

    • updated-at string(date-time)

      Service last update timestamp (ISO 8601)

    • node-count integer(int64)

      Number of service nodes in the active plan

      Minimum value is 0.

    • Grafana connection information properties

      Hide connection-info attributes Show connection-info attributes
    • node-cpu-count integer(int64)

      Number of CPUs for each node

      Minimum value is 0.

    • integrations array[dbaas-integration]

      Service integrations

      Hide integrations attributes Show integrations attributes dbaas-integration
    • zone string

      The zone where the service is running

    • node-states array[dbaas-node-state]

      Automatic maintenance settings

      Hide node-states attributes Show node-states attributes dbaas-node-state
      • name string Required

        Name of the service node

      • progress-updates array[dbaas-node-state-progress-update]

        Extra information regarding the progress for current state

        Hide progress-updates attributes Show progress-updates attributes dbaas-node-state-progress-update
        • completed boolean Required

          Indicates whether this phase has been completed or not

        • current integer(int64)

          Current progress for this phase. May be missing or null.

          Minimum value is 0.

        • max integer(int64)

          Maximum progress value for this phase. May be missing or null. May change.

          Minimum value is 0.

        • min integer(int64)

          Minimum progress value for this phase. May be missing or null.

          Minimum value is 0.

        • phase string Required

          Key identifying this phase

          Values are stream, basebackup, prepare, or finalize.

        • unit string

          Unit for current/min/max values. New units may be added. If null should be treated as generic unit

      • role string

        Role of this node. Only returned for a subset of service types

        Values are standby, master, or read-replica.

      • state string Required

        Current state of the service node

        Values are leaving, running, syncing_data, setting_up_vm, or unknown.

    • name dbaas-service-name Required

      Service name

      Minimum length is 0, maximum length is 63.

    • type dbaas-service-type-name Required

      DbaaS service name

      Minimum length is 0, maximum length is 64.

    • state enum-service-state

      State of the service

      Values are running, rebuilding, rebalancing, or poweroff.

    • grafana-settings json-schema-grafana

      Grafana specific settings

      Hide grafana-settings attributes Show grafana-settings attributes
      • allow_embedding Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking
      • dashboard_previews_enabled Enable browsing of dashboards in grid (pictures) mode

        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 Enable Grafana /metrics endpoint
      • recovery_basebackup_name Name of the basebackup to restore in forked service

        Maximum length is 128. Format should match the following pattern: ^[a-zA-Z0-9-_:.]+$.

      • auth_azuread Azure AD OAuth integration
        Hide auth_azuread attributes Show auth_azuread attributes
        • allow_sign_up Automatically sign-up users on successful sign-in
        • client_id Client ID from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • client_secret Client secret from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • auth_url Authorization URL Required

          Maximum length is 2048.

        • token_url Token URL Required

          Maximum length is 2048.

        • allowed_groups Require users to belong to one of given groups[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}$.

        • allowed_domains Allowed domains[string]

          Not more than 50 elements. Maximum length of each is 255.

      • alerting_enabled Enable or disable Grafana legacy alerting functionality. This should not be enabled with unified_alerting_enabled.
      • unified_alerting_enabled Enable or disable Grafana unified alerting functionality. By default this is enabled and any legacy alerts will be migrated on upgrade to Grafana 9+. To stay on legacy alerting, set unified_alerting_enabled to false and alerting_enabled to true. See https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts/ for more details.
      • auth_github Github Auth integration
        Hide auth_github attributes Show auth_github attributes
        • allow_sign_up Automatically sign-up users on successful sign-in
        • client_id Client ID from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • client_secret Client secret from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • team_ids Require users to belong to one of given team IDs[integer]

          Not more than 50 elements. Minimum value of each is 1, maximum value of each is 9223372036854775807.

        • allowed_organizations Require users to belong to one of given organizations[string]

          Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[A-Za-z0-9-]+$.

      • user_auto_assign_org Auto-assign new users on signup to main organization. Defaults to false
      • dataproxy_send_user_header Send 'X-Grafana-User' header to data source
      • google_analytics_ua_id Google Analytics ID

        Maximum length is 64. Format should match the following pattern: ^(G|UA|YT|MO)-[a-zA-Z0-9-]+$.

      • dashboards_versions_to_keep Dashboard versions to keep per dashboard

        Minimum value is 1, maximum value is 100.

      • editors_can_admin Editors can manage folders, teams and dashboards created by them
      • smtp_server SMTP server settings
        Hide smtp_server attributes Show smtp_server attributes
        • host Server hostname or IP Required

          Maximum length is 255.

        • port SMTP server port Required

          Minimum value is 1, maximum value is 65535.

        • skip_verify Skip verifying server certificate. Defaults to false
        • username Username for SMTP authentication | null

          Maximum length is 255. Format should match the following pattern: ^[^\x00-\x1F]+$.

        • password Password for SMTP authentication | null

          Maximum length is 255. Format should match the following pattern: ^[^\x00-\x1F]+$.

        • from_address Address used for sending emails 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 Name used in outgoing emails, defaults to Grafana | null

          Maximum length is 128. Format should match the following pattern: ^[^\x00-\x1F]+$.

        • starttls_policy Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS.

          Values are OpportunisticStartTLS, MandatoryStartTLS, or NoStartTLS.

      • auth_gitlab GitLab Auth integration
        Hide auth_gitlab attributes Show auth_gitlab attributes
        • allow_sign_up Automatically sign-up users on successful sign-in
        • api_url API URL. This only needs to be set when using self hosted GitLab

          Maximum length is 2048.

        • auth_url Authorization URL. This only needs to be set when using self hosted GitLab

          Maximum length is 2048.

        • client_id Client ID from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • client_secret Client secret from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • allowed_groups Require users to belong to one of given groups[string] Required

          Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[a-z0-9-_/]+$.

        • token_url Token URL. This only needs to be set when using self hosted GitLab

          Maximum length is 2048.

      • alerting_nodata_or_nullvalues Default value for 'no data or null values' for new alerting rules

        Values are alerting, no_data, keep_state, or ok.

      • auth_basic_enabled Enable or disable basic authentication form, used by Grafana built-in login
      • date_formats Grafana date format specifications
        Hide date_formats attributes Show date_formats attributes
        • full_date Moment.js style format string for cases where full date is shown

          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 Moment.js style format string used when a time requiring second accuracy is shown

          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 Moment.js style format string used when a time requiring minute accuracy is shown

          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 Moment.js style format string used when a time requiring hour accuracy is shown

          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 Moment.js style format string used when a time requiring day accuracy is shown

          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 Moment.js style format string used when a time requiring month accuracy is shown

          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 Moment.js style format string used when a time requiring year accuracy is shown

          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,;.: ]?)*)$.

        • default_timezone Default time zone for user preferences. Value 'browser' uses browser local time zone.

          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])$.

      • disable_gravatar Set to true to disable gravatar. Defaults to false (gravatar is enabled)
      • user_auto_assign_org_role Set role for new signups. Defaults to Viewer

        Values are Viewer, Admin, or Editor.

      • dataproxy_timeout Timeout for data proxy requests in seconds

        Minimum value is 15, maximum value is 90.

      • viewers_can_edit Users with view-only permission can edit but not save dashboards
      • dashboards_min_refresh_interval Minimum refresh interval

        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 Google Auth integration
        Hide auth_google attributes Show auth_google attributes
        • allow_sign_up Automatically sign-up users on successful sign-in
        • client_id Client ID from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • client_secret Client secret from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • allowed_domains Domains allowed to sign-in to this Grafana[string] Required

          Not more than 64 elements. Maximum length of each is 255.

      • oauth_allow_insecure_email_lookup Enforce user lookup based on email instead of the unique ID provided by the IdP
      • alerting_max_annotations_to_keep Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations.

        Minimum value is 0, maximum value is 1000000.

      • auth_generic_oauth Generic OAuth integration
        Hide auth_generic_oauth attributes Show auth_generic_oauth attributes
        • scopes OAuth scopes[string]

          Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[\S]+$.

        • allowed_domains Allowed domains[string]

          Not more than 50 elements. Maximum length of each is 255.

        • allowed_organizations Require user to be member of one of the listed organizations[string]

          Not more than 50 elements. Maximum length of each is 256. Format of each should match the following pattern: ^[\S]+$.

        • token_url Token URL Required

          Maximum length is 2048.

        • name Name of the OAuth integration

          Maximum length is 128. Format should match the following pattern: ^[a-zA-Z0-9_\- ]+$.

        • auth_url Authorization URL Required

          Maximum length is 2048.

        • api_url API URL Required

          Maximum length is 2048.

        • auto_login Allow users to bypass the login screen and automatically log in
        • client_id Client ID from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • client_secret Client secret from provider Required

          Maximum length is 1024. Format should match the following pattern: ^[ -~]+$.

        • allow_sign_up Automatically sign-up users on successful sign-in
      • alerting_error_or_timeout Default error or timeout setting for new alerting rules

        Values are alerting or keep_state.

    • ip-filter array[string]

      Allowed CIDR address blocks for incoming connections

    • backups array[dbaas-service-backup]

      List of backups for the service

      Hide backups attributes Show backups attributes dbaas-service-backup
      • backup-name string Required

        Internal name of this backup

      • backup-time string(date-time) Required

        Backup timestamp (ISO 8601)

      • data-size integer(int64) Required

        Backup's original size before compression

        Minimum value is 0.

    • Service is protected against termination and powering off

    • notifications array[dbaas-service-notification]

      Service notifications

      Hide notifications attributes Show notifications attributes dbaas-service-notification
      • level string Required

        Notification level

        Values are warning or notice.

      • message string Required

        Human notification message

        Minimum length is 1, maximum length is 1024.

      • type string Required

        Notification type

        Values are service_powered_off_removal or service_end_of_life.

      • metadata object Required

        Notification type

    • components array[object]

      Service component information objects

      Hide components attributes Show components attributes object
      • component string Required

        Service component name

      • host string Required

        DNS name for connecting to the service component

      • port integer(int64) Required

        Port number for connecting to the service component

        Minimum value is 0, maximum value is 65535.

      • route enum-component-route Required

        Network access route

        Values are dynamic, private, public, or privatelink.

      • usage enum-component-usage Required

        DNS usage name

        Values are primary or replica.

    • maintenance dbaas-service-maintenance

      Automatic maintenance settings

      Hide maintenance attributes Show maintenance attributes
      • 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.

      • updates array[dbaas-service-update] Required

        Update waiting to be installed

        Hide updates attributes Show updates attributes dbaas-service-update
        • Description of the update

        • deadline string(date-time)

          Deadline for installing the update

        • start-after string(date-time)

          The earliest time the update will be automatically applied

        • start-at string(date-time)

          The time when the update will be automatically applied

    • disk-size integer(int64)

      TODO UNIT disk space for data storage

      Minimum value is 0.

    • node-memory integer(int64)

      TODO UNIT of memory for each node

      Minimum value is 0.

    • uri string

      URI for connecting to the service (may be absent)

    • service_uri parameterized into key-value pairs

    • version string

      Grafana version

    • created-at string(date-time)

      Service creation timestamp (ISO 8601)

    • plan string Required

      Subscription plan

    • users array[object]

      List of service users

      Hide users attributes Show users attributes object
GET /dbaas-grafana/{name}
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/dbaas-grafana/{name}
Response examples (200)
{
  "description": "string",
  "updated-at": "2024-05-04T09:42:00+00:00",
  "node-count": 42,
  "connection-info": {
    "uri": "string",
    "username": "string",
    "password": "string"
  },
  "node-cpu-count": 42,
  "integrations": [
    {
      "description": "string",
      "settings": {},
      "type": "string",
      "is-enabled": true,
      "source": "string",
      "is-active": true,
      "status": "string",
      "id": "string",
      "dest": "string"
    }
  ],
  "zone": "string",
  "node-states": [
    {
      "name": "string",
      "progress-updates": [
        {
          "completed": true,
          "current": 42,
          "max": 42,
          "min": 42,
          "phase": "stream",
          "unit": "string"
        }
      ],
      "role": "standby",
      "state": "leaving"
    }
  ],
  "name": "string",
  "type": "string",
  "state": "running",
  "grafana-settings": {
    "allow_embedding": false,
    "cookie_samesite": "lax",
    "dashboard_previews_enabled": false,
    "metrics_enabled": true,
    "recovery_basebackup_name": "backup-20191112t091354293891z",
    "auth_azuread": {
      "allow_sign_up": false,
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
      "auth_url": "https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/authorize",
      "token_url": "https://login.microsoftonline.com/<AZURE_TENANT_ID>/oauth2/v2.0/token",
      "allowed_groups": [
        "c0ffee15-c01d-0000-1111-012345abcdef"
      ],
      "allowed_domains": [
        "mycompany.com"
      ]
    },
    "alerting_enabled": true,
    "unified_alerting_enabled": true,
    "auth_github": {
      "allow_sign_up": false,
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
      "team_ids": [
        150
      ],
      "allowed_organizations": [
        "aiven"
      ]
    },
    "user_auto_assign_org": false,
    "dataproxy_send_user_header": false,
    "privatelink_access": {
      "grafana": true
    },
    "google_analytics_ua_id": "UA-123456-4",
    "dashboards_versions_to_keep": 20,
    "editors_can_admin": false,
    "smtp_server": {
      "host": "smtp.example.com",
      "port": 25,
      "skip_verify": "false",
      "username": "smtpuser",
      "password": "ein0eemeev5eeth3Ahfu",
      "from_address": "yourgrafanauser@yourdomain.example.com",
      "from_name": "Company Grafana",
      "starttls_policy": "NoStartTLS"
    },
    "auth_gitlab": {
      "allow_sign_up": false,
      "api_url": "https://gitlab.com/api/v4",
      "auth_url": "https://gitlab.com/oauth/authorize",
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
      "allowed_groups": [
        "aiven/developers"
      ],
      "token_url": "https://gitlab.com/oauth/token"
    },
    "alerting_nodata_or_nullvalues": "ok",
    "auth_basic_enabled": true,
    "date_formats": {
      "full_date": "YYYY MM DD",
      "interval_second": "HH:mm:ss",
      "interval_minute": "HH:mm",
      "interval_hour": "MM/DD HH:mm",
      "interval_day": "MM/DD",
      "interval_month": "YYYY-MM",
      "interval_year": "YYYY",
      "default_timezone": "Europe/Helsinki"
    },
    "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,
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
      "allowed_domains": [
        "example.com"
      ]
    },
    "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"
  ],
  "backups": [
    {
      "backup-name": "string",
      "backup-time": "2024-05-04T09:42:00+00:00",
      "data-size": 42
    }
  ],
  "termination-protection": true,
  "notifications": [
    {
      "level": "warning",
      "message": "string",
      "type": "service_powered_off_removal",
      "metadata": {}
    }
  ],
  "components": [
    {
      "component": "string",
      "host": "string",
      "port": 42,
      "route": "dynamic",
      "usage": "primary"
    }
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string",
    "updates": [
      {
        "description": "string",
        "deadline": "2024-05-04T09:42:00+00:00",
        "start-after": "2024-05-04T09:42:00+00:00",
        "start-at": "2024-05-04T09:42:00+00:00"
      }
    ]
  },
  "disk-size": 42,
  "node-memory": 42,
  "uri": "string",
  "uri-params": {},
  "version": "string",
  "created-at": "2024-05-04T09:42:00+00:00",
  "plan": "string",
  "users": [
    {
      "type": "string",
      "username": "string",
      "password": "string"
    }
  ]
}