Path parameters

• name string Required

  Service name

  Minimum length is 0, maximum length is 63.

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • description string

    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.

  • connection-info object

    Grafana connection information properties

    Hide connection-info attributes Show connection-info attributes

    • uri string
    • username string
    • password string
  • node-cpu-count integer(int64)

    Number of CPUs for each node

    Minimum value is 0.

  • integrations array[object]

    Service integrations

    Hide integrations attributes Show integrations attributes object

    • 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 array[object]

    State of individual service nodes

    Hide node-states attributes Show node-states attributes object

    Automatic maintenance settings

    • name string Required

      Name of the service node

    • progress-updates array[object]

      Extra information regarding the progress for current state

      Hide progress-updates attributes Show progress-updates attributes object

      Extra information regarding the progress for current state

      • 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 string Required

    Service name

    Minimum length is 0, maximum length is 63.

  • type string Required

    DbaaS service name

    Minimum length is 0, maximum length is 64.

  • state string

    State of the service

    Values are running, rebuilding, rebalancing, or poweroff.

  • grafana-settings object

    Grafana specific settings

    Hide grafana-settings attributes Show grafana-settings attributes

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

      • 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.

      • Additional properties are NOT allowed
    • alerting_enabled boolean
    • unified_alerting_enabled boolean
    • auth_github object
      Hide auth_github attributes Show auth_github attributes

      • 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.

      • Additional properties are NOT allowed
    • 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
      Hide smtp_server attributes Show smtp_server attributes

      • 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]+$.

      • Additional properties are NOT allowed
    • auth_gitlab object
      Hide auth_gitlab attributes Show auth_gitlab attributes

      • 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.

      • Additional properties are NOT allowed
    • alerting_nodata_or_nullvalues string

      Values are alerting, no_data, keep_state, or ok.

    • auth_basic_enabled boolean
    • date_formats object
      Hide date_formats attributes Show date_formats attributes

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

      • Additional properties are NOT allowed
    • 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
      Hide auth_google attributes Show auth_google attributes

      • 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: ^[ -~]+$.

      • Additional properties are NOT allowed
    • oauth_allow_insecure_email_lookup boolean
    • alerting_max_annotations_to_keep integer

      Minimum value is 0, maximum value is 1000000.

    • auth_generic_oauth object
      Hide auth_generic_oauth attributes Show auth_generic_oauth attributes

      • 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
      • Additional properties are NOT allowed
    • alerting_error_or_timeout string

      Values are alerting or keep_state.

  • ip-filter array[string]

    Allowed CIDR address blocks for incoming connections

  • backups array[object]

    List of backups for the service

    Hide backups attributes Show backups attributes object

    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(int64) Required

      Backup's original size before compression

      Minimum value is 0.

  • termination-protection boolean

    Service is protected against termination and powering off

  • notifications array[object]

    Service notifications

    Hide notifications attributes Show notifications attributes object

    Service notifications

    • 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 string Required

      Network access route

      Values are dynamic, private, public, or privatelink.

    • usage string Required

      DNS usage name

      Values are primary or replica.

  • maintenance object

    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[object] Required

      List of updates waiting to be installed

      Hide updates attributes Show updates attributes object

      Update 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(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)

  • 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 array[object]

    List of service users

    Hide users attributes Show users attributes object

    • type string
    • username string
    • password string