Path parameters

• name string Required

  Minimum length is 0, maximum length is 63.

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • 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

    Thanos connection information properties

    Hide connection-info attributes Show connection-info attributes object

    • query-frontend-uri string
    • query-uri string
    • receiver-remote-write-uri string
    • ruler-uri string
  • node-cpu-count integer(int64)

    Number of CPUs for each node

    Minimum value is 0.

  • prometheus-uri object Required

    Prometheus integration URI

    Hide prometheus-uri attributes Show prometheus-uri attributes object

    • host string
    • port integer(int64)

      Minimum value is 0, maximum value is 65535.

  • 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

    Automatic maintenance settings

    Hide node-states attributes Show node-states attributes object

    • name string Required

      Name of the service node

    • progress-updates array[object]

      Extra information regarding the progress for current state

      Extra information regarding the progress for current state

      Hide progress-updates attributes Show progress-updates attributes object

      • 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

    Minimum length is 0, maximum length is 63.

  • type string Required

    Minimum length is 0, maximum length is 64.

  • state string

    Values are running, rebuilding, rebalancing, or poweroff.

  • ip-filter array[string]

    Allowed CIDR address blocks for incoming connections

  • backups array[object]

    List of backups for the service

    List of backups for the service

    Hide backups attributes Show backups attributes object

    • 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

    Service notifications

    Hide notifications attributes Show notifications attributes object

    • 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

      Values are dynamic, private, public, or privatelink.

    • ssl boolean

      Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption.

    • usage string Required

      Values are primary or replica.

  • maintenance object

    Automatic maintenance settings

    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.

    • updates array[object] Required

      List of updates waiting to be installed

      Update waiting to be installed

      Hide updates attributes Show updates attributes object

      • 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

  • thanos-settings object
    Hide thanos-settings attributes Show thanos-settings attributes object

    • compactor object

      Configuration options for Thanos Compactor.

      Hide compactor attribute Show compactor attribute object

      • retention.days integer

        Retention time for data in days for each resolution (5m, 1h, raw)

        Minimum value is 0.

    • query object

      Configuration options for Thanos Query.

      Hide query attributes Show query attributes object

      • query.default-evaluation-interval string

        Set the default evaluation interval for subqueries.

        Maximum length is 20. Default value is 1m.

      • query.lookback-delta string

        The maximum lookback duration for retrieving metrics during expression evaluations in PromQL. PromQL always evaluates the query for a certain timestamp, and it looks back for the given amount of time to get the latest sample. If it exceeds the maximum lookback delta, it assumes the series is stale and returns none (a gap). The lookback delta should be set to at least 2 times the slowest scrape interval. If unset, it will use the promql default of 5m.

        Maximum length is 20. Default value is 5m.

      • query.metadata.default-time-range string

        The default metadata time range duration for retrieving labels through Labels and Series API when the range parameters are not specified. The zero value means the range covers the time since the beginning.

        Maximum length is 20. Default value is 0s.

      • query.timeout string

        Maximum time to process a query by the query node.

        Maximum length is 20. Default value is 2m.

      • store.limits.request-samples integer

        The maximum samples allowed for a single Series request. The Series call fails if this limit is exceeded. Set to 0 for no limit. NOTE: For efficiency, the limit is internally implemented as 'chunks limit' considering each chunk contains a maximum of 120 samples. The default value is 100 * store.limits.request-series.

        Minimum value is 0, maximum value is 100000000. Default value is 0.

      • store.limits.request-series integer

        The maximum series allowed for a single Series request. The Series call fails if this limit is exceeded. Set to 0 for no limit. The default value is 1000 * cpu_count.

        Minimum value is 0, maximum value is 100000000. Default value is 0.

    • query-frontend object

      Configuration options for Thanos Query Frontend.

      Hide query-frontend attribute Show query-frontend attribute object

      • query-range.align-range-with-step boolean

        Whether to align the query range boundaries with the step. If enabled, the query range boundaries will be aligned to the step, providing more accurate results for queries with high-resolution data.

        Default value is true.

  • 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