DBaaS Thanos

Thanos is a large-scale metrics management system.

create-dbaas-service-thanos

Create a DBaaS Thanos service

POST /dbaas-thanos/{name}

Create a DBaaS Thanos service

Path parameters

Name	In	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`plan`	string	yes	Subscription plan
`ip-filter`	array[string]	no	Allowed CIDR address blocks for incoming connections
`maintenance`	object	no	Automatic maintenance settings schema details
`termination-protection`	boolean	no	Service is protected against termination and powering off
`thanos-settings`	object	no	Thanos specific settings schema details

Example

{
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "thanos-settings": {
    "compactor": {
      "retention.days": 0
    },
    "query": {
      "query.default-evaluation-interval": "1m",
      "query.lookback-delta": "5m",
      "query.metadata.default-time-range": "0s",
      "query.timeout": "2m",
      "store.limits.request-samples": 0,
      "store.limits.request-series": 0
    },
    "query-frontend": {
      "query-range.align-range-with-step": true
    }
  }
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-dbaas-service-thanos: golang | Python | Java

CLI: exo api create-dbaas-service-thanos

get-dbaas-service-thanos

GET /dbaas-thanos/{name}

Get a DBaaS Thanos service

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`backups`	array[object]	List of backups for the service schema details
`components`	array[object]	Service component information objects schema details
`connection-info`	object	Thanos connection information properties schema details
`created-at`	string	Service creation timestamp (ISO 8601)
`disk-size`	integer	TODO UNIT disk space for data storage
`integrations`	array[object]	Service integrations schema details
`ip-filter`	array[string]	Allowed CIDR address blocks for incoming connections
`maintenance`	object	Automatic maintenance settings schema details
`name`	string	Service name
`node-count`	integer	Number of service nodes in the active plan
`node-cpu-count`	integer	Number of CPUs for each node
`node-memory`	integer	TODO UNIT of memory for each node
`node-states`	array[object]	State of individual service nodes schema details
`notifications`	array[object]	Service notifications schema details
`plan`	string	Subscription plan
`prometheus-uri`	object	Prometheus integration URI schema details
`state`	string	State of the service Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`.
`termination-protection`	boolean	Service is protected against termination and powering off
`thanos-settings`	object	Thanos specific settings schema details
`type`	string	Service type code
`updated-at`	string	Service last update timestamp (ISO 8601)
`uri`	string	URI for connecting to the service (may be absent)
`uri-params`	object	service_uri parameterized into key-value pairs
`users`	array[object]	List of service users schema details
`zone`	string	The zone where the service is running

Example output

{
  "backups": [
    {
      "backup-name": "string",
      "backup-time": "2024-01-01T12:00:00Z",
      "data-size": 0
    }
  ],
  "components": [
    {
      "component": "string",
      "host": "string",
      "port": 0,
      "route": "dynamic",
      "ssl": true,
      "usage": "primary"
    }
  ],
  "connection-info": {
    "query-frontend-uri": "string",
    "query-uri": "string",
    "receiver-remote-write-uri": "string",
    "ruler-uri": "string"
  },
  "created-at": "2024-01-01T12:00:00Z",
  "disk-size": 0,
  "integrations": [
    {
      "description": "string",
      "dest": "string",
      "id": "string",
      "is-active": true,
      "is-enabled": true,
      "settings": {},
      "source": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string",
    "updates": [
      {
        "deadline": "2024-01-01T12:00:00Z",
        "description": "string",
        "start-after": "2024-01-01T12:00:00Z",
        "start-at": "2024-01-01T12:00:00Z"
      }
    ]
  },
  "name": "string",
  "node-count": 0,
  "node-cpu-count": 0,
  "node-memory": 0,
  "node-states": [
    {
      "name": "string",
      "progress-updates": [
        {
          "completed": true,
          "current": 0,
          "max": 0,
          "min": 0,
          "phase": "stream",
          "unit": "string"
        }
      ],
      "role": "standby",
      "state": "leaving"
    }
  ],
  "notifications": [
    {
      "level": "warning",
      "message": "string",
      "metadata": {},
      "type": "service_powered_off_removal"
    }
  ],
  "plan": "string",
  "prometheus-uri": {
    "host": "string",
    "port": 0
  },
  "state": "running",
  "termination-protection": true,
  "thanos-settings": {
    "compactor": {
      "retention.days": 0
    },
    "query": {
      "query.default-evaluation-interval": "1m",
      "query.lookback-delta": "5m",
      "query.metadata.default-time-range": "0s",
      "query.timeout": "2m",
      "store.limits.request-samples": 0,
      "store.limits.request-series": 0
    },
    "query-frontend": {
      "query-range.align-range-with-step": true
    }
  },
  "type": "string",
  "updated-at": "2024-01-01T12:00:00Z",
  "uri": "string",
  "uri-params": {},
  "users": [
    {
      "password": "string",
      "type": "string",
      "username": "string"
    }
  ],
  "zone": "string"
}

SDK reference for get-dbaas-service-thanos: golang | Python | Java

CLI: exo api get-dbaas-service-thanos

update-dbaas-service-thanos

PUT /dbaas-thanos/{name}

Update a DBaaS Thanos service

Path parameters

Name	In	Description
`name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`ip-filter`	array[string]	no	Allowed CIDR address blocks for incoming connections
`maintenance`	object	no	Automatic maintenance settings schema details
`plan`	string	no	Subscription plan
`termination-protection`	boolean	no	Service is protected against termination and powering off
`thanos-settings`	object	no	Thanos specific settings schema details

Example

{
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "thanos-settings": {
    "compactor": {
      "retention.days": 0
    },
    "query": {
      "query.default-evaluation-interval": "1m",
      "query.lookback-delta": "5m",
      "query.metadata.default-time-range": "0s",
      "query.timeout": "2m",
      "store.limits.request-samples": 0,
      "store.limits.request-series": 0
    },
    "query-frontend": {
      "query-range.align-range-with-step": true
    }
  }
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for update-dbaas-service-thanos: golang | Python | Java

CLI: exo api update-dbaas-service-thanos

delete-dbaas-service-thanos

Delete a Thanos service

DELETE /dbaas-thanos/{name}

null

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-dbaas-service-thanos: golang | Python | Java

CLI: exo api delete-dbaas-service-thanos

Other Operations

get-dbaas-settings-thanos

Get DBaaS Thanos settings

GET /dbaas-settings-thanos

Get DBaaS Thanos settings

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`settings`	object	schema details

Example output

{
  "settings": {
    "thanos": {
      "additionalProperties": true,
      "properties": {},
      "title": "string",
      "type": "string"
    }
  }
}

SDK reference for get-dbaas-settings-thanos: golang | Python | Java

CLI: exo api get-dbaas-settings-thanos

start-dbaas-thanos-maintenance

Initiate Thanos maintenance update

PUT /dbaas-thanos/{name}/maintenance/start

null

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for start-dbaas-thanos-maintenance: golang | Python | Java

CLI: exo api start-dbaas-thanos-maintenance

reveal-dbaas-thanos-user-password

Reveal the secrets of a DBaaS Thanos user

GET /dbaas-thanos/{service-name}/user/{username}/password/reveal

null

Path parameters

Name	In	Description
`service-name`	`path`
`username`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`password`	string	Thanos password
`username`	string	Thanos username

Example output

{
  "password": "string",
  "username": "string"
}

SDK reference for reveal-dbaas-thanos-user-password: golang | Python | Java

CLI: exo api reveal-dbaas-thanos-user-password

Last updated on January 28, 2026