dbaas

Get a DBaaS Grafana service

get/dbaas-grafana/{name}

Request

Path parameters

namestring required

Response

200

descriptionstring

DbaaS service description

updated-atstring date-time

Service last update timestamp (ISO 8601)

node-countinteger

Number of service nodes in the active plan

node-cpu-countinteger

Number of CPUs for each node

zonestring

The zone where the service is running

namestring required
typestring required
state'running' | 'rebuilding' | 'rebalancing' | 'poweroff'
ip-filterstring[]

Allowed CIDR address blocks for incoming connections

termination-protectionboolean

Service is protected against termination and powering off

disk-sizeinteger

TODO UNIT disk space for data storage

node-memoryinteger

TODO UNIT of memory for each node

uristring

URI for connecting to the service (may be absent)

uri-paramsobject

service_uri parameterized into key-value pairs

versionstring

Grafana version

created-atstring date-time

Service creation timestamp (ISO 8601)

planstring required

Subscription plan

Example response

{
  "grafana-settings": {
    "cookie_samesite": "lax",
    "metrics_enabled": true,
    "auth_azuread": {
      "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": {
      "allowed_organizations": [
        "aiven"
      ],
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b",
      "team_ids": [
        150
      ]
    },
    "google_analytics_ua_id": "UA-123456-4",
    "dashboards_versions_to_keep": 20,
    "smtp_server": {
      "from_address": "yourgrafanauser@yourdomain.example.com",
      "from_name": "Company Grafana",
      "host": "smtp.example.com",
      "password": "ein0eemeev5eeth3Ahfu",
      "port": 25,
      "starttls_policy": "NoStartTLS",
      "username": "smtpuser"
    },
    "auth_gitlab": {
      "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,
    "user_auto_assign_org_role": "Viewer",
    "dataproxy_timeout": 30,
    "dashboards_min_refresh_interval": "5s",
    "auth_google": {
      "allowed_domains": [
        "example.com"
      ],
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b"
    },
    "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",
      "client_id": "b1ba0bf54a4c2c0a1c29",
      "client_secret": "bfa6gea4f129076761dcba8ce5e1e406bd83af7b"
    },
    "custom_domain": "grafana.example.org",
    "alerting_error_or_timeout": "alerting"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.