---
title: "Get a DBaaS Grafana service"
method: GET
path: "/dbaas-grafana/{name}"
tags: ["dbaas"]
---

# Get a DBaaS Grafana service

`GET /dbaas-grafana/{name}`

## Request

- Base URL: `https://api-ch-gva-2.exoscale.com/v2`
- URL: `https://api-ch-gva-2.exoscale.com/v2/dbaas-grafana/{name}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/exoscale/apis/exoscale-api/docs/dbaas-grafana/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `name` string, required

## Response `200`

200

- DbaasServiceGrafana
  - `description` string: DbaaS service description
  - `updated-at` string, date-time: Service last update timestamp (ISO 8601)
  - `node-count` integer: Number of service nodes in the active plan
  - `connection-info` object: Grafana connection information properties
    - `uri` string
    - `username` string
    - `password` string
  - `node-cpu-count` integer: Number of CPUs for each node
  - `prometheus-uri` object, required: Prometheus integration URI
    - `host` string
    - `port` integer
  - `integrations` DbaasIntegration[]: Service integrations
    - `description` string: Description of the integration
    - `settings` object: Integration settings
    - `type` string: Integration type
    - `is-enabled` boolean: Whether the integration is enabled or not
    - `source` string: Source service name
    - `is-active` boolean: Whether the integration is active or not
    - `status` string: Integration status
    - `id` string, uuid: Integration id
    - `dest` string: Destination service name
  - `zone` string: The zone where the service is running
  - `node-states` DbaasNodeState[]: State of individual service nodes
    - `name` string, required: Name of the service node
    - `progress-updates` DbaasNodeStateProgressUpdate[]: Extra information regarding the progress for current state
      - `completed` boolean, required: Indicates whether this phase has been completed or not
      - `current` integer: Current progress for this phase. May be missing or null.
      - `max` integer: Maximum progress value for this phase. May be missing or null. May change.
      - `min` integer: Minimum progress value for this phase. May be missing or null.
      - `phase` 'stream' | 'basebackup' | 'prepare' | 'finalize', required: Key identifying this phase
      - `unit` string: Unit for current/min/max values. New units may be added. If null should be treated as generic unit
    - `role` 'standby' | 'master' | 'read-replica': Role of this node. Only returned for a subset of service types
    - `state` 'leaving' | 'running' | 'syncing_data' | 'setting_up_vm' | 'unknown', required: Current state of the service node
  - `name` string, required
  - `type` string, required
  - `state` 'running' | 'rebuilding' | 'rebalancing' | 'poweroff'
  - `grafana-settings` JsonSchemaGrafana
    - `allow_embedding` boolean
    - `cookie_samesite` 'lax' | 'strict' | '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
      - `allow_sign_up` boolean
      - `allowed_domains` string[]
      - `allowed_groups` string[]
      - `auth_url` string, required
      - `client_id` string, required
      - `client_secret` string, required
      - `token_url` string, required
    - `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
      - `allow_sign_up` boolean
      - `allowed_organizations` string[]
      - `auto_login` boolean
      - `client_id` string, required
      - `client_secret` string, required
      - `skip_org_role_sync` boolean
      - `team_ids` integer[]
    - `user_auto_assign_org` boolean
    - `dataproxy_send_user_header` boolean
    - `google_analytics_ua_id` string
    - `dashboards_versions_to_keep` integer
    - `editors_can_admin` boolean
    - `smtp_server` object
      - `from_address` string, required
      - `from_name` string, nullable
      - `host` string, required
      - `password` string, nullable
      - `port` integer, required
      - `skip_verify` boolean
      - `starttls_policy` 'OpportunisticStartTLS' | 'MandatoryStartTLS' | 'NoStartTLS'
      - `username` string, nullable
    - `auth_gitlab` object
      - `allow_sign_up` boolean
      - `allowed_groups` string[], required
      - `api_url` string
      - `auth_url` string
      - `client_id` string, required
      - `client_secret` string, required
      - `token_url` string
    - `alerting_nodata_or_nullvalues` 'alerting' | 'no_data' | 'keep_state' | 'ok'
    - `auth_basic_enabled` boolean
    - `date_formats` object
      - `default_timezone` string
      - `full_date` string
      - `interval_day` string
      - `interval_hour` string
      - `interval_minute` string
      - `interval_month` string
      - `interval_second` string
      - `interval_year` string
    - `service_log` boolean, nullable: Store logs for the service so that they are available in the HTTP API and console.
    - `disable_gravatar` boolean
    - `user_auto_assign_org_role` 'Viewer' | 'Admin' | 'Editor'
    - `dataproxy_timeout` integer
    - `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
    - `auth_google` object
      - `allow_sign_up` boolean
      - `allowed_domains` string[], required
      - `client_id` string, required
      - `client_secret` string, required
    - `oauth_allow_insecure_email_lookup` boolean
    - `alerting_max_annotations_to_keep` integer
    - `auth_generic_oauth` object
      - `scopes` string[]
      - `allowed_domains` string[]
      - `allowed_organizations` string[]
      - `token_url` string, required
      - `name` string
      - `auth_url` string, required
      - `api_url` string, required
      - `auto_login` boolean
      - `client_id` string, required
      - `client_secret` string, required
      - `allow_sign_up` boolean
    - `custom_domain` string, nullable: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
    - `alerting_error_or_timeout` 'alerting' | 'keep_state'
  - `ip-filter` string[]: Allowed CIDR address blocks for incoming connections
  - `backups` DbaasServiceBackup[]: List of backups for the service
    - `backup-name` string, required: Internal name of this backup
    - `backup-time` string, date-time, required: Backup timestamp (ISO 8601)
    - `data-size` integer, required: Backup's original size before compression
  - `termination-protection` boolean: Service is protected against termination and powering off
  - `notifications` DbaasServiceNotification[]: Service notifications
    - `level` 'warning' | 'notice', required: Notification level
    - `message` string, required: Human notification message
    - `type` 'service_powered_off_removal' | 'service_end_of_life', required: Notification type
    - `metadata` object, required: Notification type
  - `components` object[]: Service component information objects
    - `component` string, required: Service component name
    - `host` string, required: DNS name for connecting to the service component
    - `port` integer, required: Port number for connecting to the service component
    - `route` 'dynamic' | 'private' | 'public' | 'privatelink', required
    - `usage` 'primary' | 'replica', required
  - `maintenance` DbaasServiceMaintenance: Automatic maintenance settings
    - `dow` 'saturday' | 'tuesday' | 'never' | 'wednesday' | 'sunday' | 'friday' | 'monday' | 'thursday', required: Day of week for installing updates
    - `time` string, required: Time for installing updates, UTC
    - `updates` DbaasServiceUpdate[], required: List of updates waiting to be installed
      - `description` string: 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: TODO UNIT disk space for data storage
  - `node-memory` integer: TODO UNIT of memory for each node
  - `uri` string: URI for connecting to the service (may be absent)
  - `uri-params` object: 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` object[]: List of service users
    - `type` string
    - `username` string
    - `password` string

## Changes

- **2025-05-22** `37a05010e8b4`: 1 info
  - added the required property `prometheus-uri` to the response with the `200` status
- **2024-09-18** `eae1143f1c63`: 2 info
  - added the optional property `grafana-settings/custom_domain` to the response with the `200` status
  - added the optional property `grafana-settings/wal` to the response with the `200` status
- **2024-05-22** `d1903c399d90`: 2 warning, 3 info
  - removed the optional property `grafana-settings/privatelink_access` from the response with the `200` status
  - removed the optional property `grafana-settings/recovery_basebackup_name` from the response with the `200` status
  - added the optional property `grafana-settings/auth_github/auto_login` to the response with the `200` status
  - added the optional property `grafana-settings/auth_github/skip_org_role_sync` to the response with the `200` status
  - …1 more
- **2023-12-08** `ec6a2a6bc1c1`: 30 info
  - added the optional property `grafana-settings/alerting_enabled` to the response with the `200` status
  - added the optional property `grafana-settings/alerting_error_or_timeout` to the response with the `200` status
  - added the optional property `grafana-settings/alerting_max_annotations_to_keep` to the response with the `200` status
  - added the optional property `grafana-settings/alerting_nodata_or_nullvalues` to the response with the `200` status
  - …26 more
- **2023-06-06** `cf7b08181585`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/dbaas-grafana/:name/get.md)

---

[API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)