DBaaS Management

Operational management for DBaaS services: logs, metrics, service types and lifecycle.

create-dbaas-clickhouse-user

[BETA] Create a DBaaS ClickHouse user

POST /dbaas-clickhouse/{service-name}/user

null

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`username`	string	yes	Username Min length: `1`. Max length: `64`.
`password`	string	no	Password Min length: `8`. Max length: `256`.
`roles`	array of DBaaS Clickhouse User Role Input	no	ClickHouse roles to grant to the user

Example

{
  "password": "string",
  "roles": [
    {
      "uuid": "string"
    }
  ],
  "username": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`password`	string	ClickHouse password
`username`	string	ClickHouse username

Example output

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

SDK reference for create-dbaas-clickhouse-user: golang | Python | Java

CLI: exo api create-dbaas-clickhouse-user

delete-dbaas-clickhouse-user

[BETA] Delete a DBaaS ClickHouse user

DELETE /dbaas-clickhouse/{service-name}/user/{user-uuid}

null

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.
`user-uuid`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-clickhouse-user: golang | Python | Java

CLI: exo api delete-dbaas-clickhouse-user

reveal-dbaas-clickhouse-user-password

[BETA] Reveal the secrets of a DBaaS ClickHouse user

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

null

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.
`username`	`path`	Min length: `1`. Max length: `64`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`password`	string	ClickHouse password
`username`	string	ClickHouse username

Example output

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

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

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

reset-dbaas-clickhouse-user-password

[BETA] Reset the credentials of a DBaaS ClickHouse user

PUT /dbaas-clickhouse/{service-name}/user/{username}/password/reset

null

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.
`username`	`path`	Min length: `1`. Max length: `64`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`password`	string	no	New password Min length: `8`. Max length: `256`.

Example

{
  "password": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`password`	string	ClickHouse password
`username`	string	ClickHouse username

Example output

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

SDK reference for reset-dbaas-clickhouse-user-password: golang | Python | Java

CLI: exo api reset-dbaas-clickhouse-user-password

create-dbaas-integration

POST /dbaas-integration

[BETA] Create a new DBaaS integration between two services

Request body

Content-Type: application/json

Property	Type	Required	Description
`dest-service`	string	yes	A destination service Min length: `0`. Max length: `63`.
`integration-type`	string	yes	Integration type Allowed values: `datasource`, `logs`, `metrics`.
`source-service`	string	yes	A source service Min length: `0`. Max length: `63`.
`settings`	object	no	Integration settings

Example

{
  "dest-service": "string",
  "integration-type": "datasource",
  "settings": {},
  "source-service": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-integration: golang | Python | Java

CLI: exo api create-dbaas-integration

get-dbaas-integration

GET /dbaas-integration/{id}

[BETA] Get a DBaaS Integration

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`description`	string	Description of the integration
`dest`	string	Destination service name
`id`	string	Integration id Must be a valid UUID.
`is-active`	boolean	Whether the integration is active or not
`is-enabled`	boolean	Whether the integration is enabled or not
`settings`	object	Integration settings
`source`	string	Source service name
`status`	string	Integration status
`type`	string	Integration type

Example output

{
  "description": "string",
  "dest": "string",
  "id": "string",
  "is-active": true,
  "is-enabled": true,
  "settings": {},
  "source": "string",
  "status": "string",
  "type": "string"
}

SDK reference for get-dbaas-integration: golang | Python | Java

CLI: exo api get-dbaas-integration

update-dbaas-integration

PUT /dbaas-integration/{id}

[BETA] Update a existing DBaaS integration

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Request body

Content-Type: application/json

Property	Type	Required	Description
`settings`	object	yes	Integration settings

Example

{
  "settings": {}
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-integration: golang | Python | Java

CLI: exo api update-dbaas-integration

delete-dbaas-integration

DELETE /dbaas-integration/{id}

[BETA] Delete a DBaaS Integration

Path parameters

Name	In	Description
`id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-integration: golang | Python | Java

CLI: exo api delete-dbaas-integration

create-dbaas-service-clickhouse

[BETA] Create a DBaaS ClickHouse service

POST /dbaas-clickhouse/{name}

null

Path parameters

Name	In	Description
`name`	`path`	Min length: `0`. Max length: `63`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`plan`	string	yes	Subscription plan Min length: `1`. Max length: `128`.
`clickhouse-settings`	ClickHouse settings	no	ClickHouse-specific settings
`fork-from-service`	string	no	Service to fork from Min length: `0`. Max length: `63`.
`ip-filter`	array[string]	no	Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
`maintenance`	Maintenance	no	Automatic maintenance settings
`recovery-backup-name`	string	no	Name of a backup to recover from for services that support backup names Min length: `1`.
`termination-protection`	boolean	no	Service is protected against termination and powering off
`version`	string	no	ClickHouse major version Min length: `1`.

Example

{
  "clickhouse-settings": {
    "server_settings": {
      "vector_similarity_index_cache_size": 0
    }
  },
  "fork-from-service": "string",
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "recovery-backup-name": "string",
  "termination-protection": true,
  "version": "string"
}

Maintenance

Automatic maintenance settings

Property	Type	Required	Description
`dow`	string	yes	Day of week for installing updates Allowed values: `saturday`, `tuesday`, `never`, `wednesday`, `sunday`, `friday`, `monday`, `thursday`.
`time`	string	yes	Time for installing updates, UTC Min length: `8`. Max length: `8`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-clickhouse: golang | Python | Java

CLI: exo api create-dbaas-service-clickhouse

get-dbaas-service-clickhouse

[BETA] Get a DBaaS ClickHouse service

GET /dbaas-clickhouse/{name}

null

Path parameters

Name	In	Description
`name`	`path`	Min length: `0`. Max length: `63`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`backups`	array of List of backups for the service	List of backups for the service
`clickhouse-settings`	ClickHouse settings	ClickHouse-specific settings
`components`	array of Components	Service component information objects
`connection-info`	Connection Info	ClickHouse connection information properties
`created-at`	string	Service creation timestamp (ISO 8601) ISO 8601 date-time.
`disk-size`	integer	TODO UNIT disk space for data storage Min: `0`.
`integrations`	array of DBaaS Integration	Service integrations
`ip-filter`	array[string]	Allowed CIDR address blocks for incoming connections
`maintenance`	Automatic maintenance settings	Automatic maintenance settings
`name`	string	Service name Min length: `0`. Max length: `63`.
`node-count`	integer	Number of service nodes in the active plan Min: `0`.
`node-cpu-count`	integer	Number of CPUs for each node Min: `0`.
`node-memory`	integer	TODO UNIT of memory for each node Min: `0`.
`node-states`	array of Automatic maintenance settings	State of individual service nodes
`notifications`	array of Service notifications	Service notifications
`plan`	string	Subscription plan
`prometheus-uri`	Prometheus URI	Prometheus integration URI
`state`	string	State of the service Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`.
`termination-protection`	boolean	Service is protected against termination and powering off
`type`	string	Service type code Min length: `0`. Max length: `64`.
`updated-at`	string	Service last update timestamp (ISO 8601) ISO 8601 date-time.
`uri`	string	URI for connecting to the service (may be absent)
`uri-params`	object	service_uri parameterized into key-value pairs
`users`	array of DBaaS Clickhouse User	List of ClickHouse users
`version`	string	ClickHouse version
`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
    }
  ],
  "clickhouse-settings": {
    "server_settings": {
      "vector_similarity_index_cache_size": 0
    }
  },
  "components": [
    {
      "component": "string",
      "host": "string",
      "port": 0,
      "route": "dynamic",
      "ssl": true,
      "usage": "primary"
    }
  ],
  "connection-info": {
    "arrowflight-uri": "string",
    "mysql-uri": "string",
    "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,
  "type": "string",
  "updated-at": "2024-01-01T12:00:00Z",
  "uri": "string",
  "uri-params": {},
  "users": [
    {
      "required": true,
      "username": "string",
      "uuid": "string"
    }
  ],
  "version": "string",
  "zone": "string"
}

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

CLI: exo api get-dbaas-service-clickhouse

update-dbaas-service-clickhouse

[BETA] Update a DBaaS ClickHouse service

PUT /dbaas-clickhouse/{name}

null

Path parameters

Name	In	Description
`name`	`path`	Min length: `0`. Max length: `63`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`clickhouse-settings`	ClickHouse settings	no	ClickHouse-specific settings
`ip-filter`	array[string]	no	Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
`maintenance`	Maintenance	no	Automatic maintenance settings
`plan`	string	no	Subscription plan Min length: `1`. Max length: `128`.
`termination-protection`	boolean	no	Service is protected against termination and powering off
`version`	string	no	ClickHouse major version Min length: `1`.

Example

{
  "clickhouse-settings": {
    "server_settings": {
      "vector_similarity_index_cache_size": 0
    }
  },
  "ip-filter": [
    "string"
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "version": "string"
}

Maintenance

Automatic maintenance settings

Property	Type	Required	Description
`dow`	string	yes	Day of week for installing updates Allowed values: `saturday`, `tuesday`, `never`, `wednesday`, `sunday`, `friday`, `monday`, `thursday`.
`time`	string	yes	Time for installing updates, UTC Min length: `8`. Max length: `8`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-clickhouse: golang | Python | Java

CLI: exo api update-dbaas-service-clickhouse

delete-dbaas-service-clickhouse

[BETA] Delete a ClickHouse service

DELETE /dbaas-clickhouse/{name}

null

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-clickhouse: golang | Python | Java

CLI: exo api delete-dbaas-service-clickhouse

Other Operations

get-dbaas-ca-certificate

Get DBaaS CA Certificate

GET /dbaas-ca-certificate

Returns a CA Certificate required to reach a DBaaS service through a TLS-protected connection.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`certificate`	string

Example output

{
  "certificate": "string"
}

SDK reference for get-dbaas-ca-certificate: golang | Python | Java

CLI: exo api get-dbaas-ca-certificate

get-dbaas-clickhouse-acl-config

[BETA] Get DBaaS ClickHouse ACL configuration

GET /dbaas-clickhouse/{service-name}/acl-config

null

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`users`	array of DBaaS Clickhouse User Acl Config

Example output

{
  "users": [
    {
      "privileges": [
        {
          "access-type": "string",
          "column": "string",
          "database": "string",
          "grant-option": true,
          "partial-revoke": true,
          "table": "string"
        }
      ],
      "roles": [
        {
          "default": true,
          "name": "string",
          "uuid": "string",
          "with-admin-option": true
        }
      ],
      "username": "string",
      "uuid": "string"
    }
  ]
}

SDK reference for get-dbaas-clickhouse-acl-config: golang | Python | Java

CLI: exo api get-dbaas-clickhouse-acl-config

start-dbaas-clickhouse-maintenance

[BETA] Initiate ClickHouse maintenance update

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

null

Path parameters

Name	In	Description
`name`	`path`	Min length: `0`. Max length: `63`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-clickhouse-maintenance: golang | Python | Java

CLI: exo api start-dbaas-clickhouse-maintenance

list-dbaas-clickhouse-users

[BETA] List DBaaS ClickHouse users

GET /dbaas-clickhouse/{service-name}/user

null

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`users`	array of DBaaS Clickhouse User

Example output

{
  "users": [
    {
      "required": true,
      "username": "string",
      "uuid": "string"
    }
  ]
}

SDK reference for list-dbaas-clickhouse-users: golang | Python | Java

CLI: exo api list-dbaas-clickhouse-users

get-dbaas-external-integration

GET /dbaas-external-integration/{integration-id}

[BETA] Get a DBaaS external integration

Path parameters

Name	In	Description
`integration-id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`description`	string	Description of the integration
`dest-endpoint-id`	string	External destination endpoint id
`dest-endpoint-name`	string	External destination endpoint name
`integration-id`	string	Endpoint integration UUID Must be a valid UUID.
`source-service-name`	string	DBaaS source service name
`source-service-type`	string	DBaaS service type Min length: `0`. Max length: `64`.
`status`	string	Integration status
`type`	string	Integration Type Allowed values: `prometheus`, `opensearch`, `rsyslog`, `datadog`, `elasticsearch`.

Example output

{
  "description": "string",
  "dest-endpoint-id": "string",
  "dest-endpoint-name": "string",
  "integration-id": "string",
  "source-service-name": "string",
  "source-service-type": "string",
  "status": "string",
  "type": "prometheus"
}

SDK reference for get-dbaas-external-integration: golang | Python | Java

CLI: exo api get-dbaas-external-integration

list-dbaas-external-integrations

GET /dbaas-external-integrations/{service-name}

[BETA] List all DBaaS connections between services and external endpoints

Path parameters

Name	In	Description
`service-name`	`path`	Min length: `0`. Max length: `63`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`external-integrations`	array of Integrations with other services

Example output

{
  "external-integrations": [
    {
      "description": "string",
      "dest-endpoint-id": "string",
      "dest-endpoint-name": "string",
      "integration-id": "string",
      "source-service-name": "string",
      "source-service-type": "string",
      "status": "string",
      "type": "prometheus"
    }
  ]
}

SDK reference for list-dbaas-external-integrations: golang | Python | Java

CLI: exo api list-dbaas-external-integrations

list-dbaas-integration-settings

GET /dbaas-integration-settings/{integration-type}/{source-type}/{dest-type}

[BETA] Get DBaaS integration settings

Path parameters

Name	In	Description
`integration-type`	`path`
`source-type`	`path`
`dest-type`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`settings`	Settings	The JSON schema representing the settings for the given integration type, source, and destination service types.

Example output

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

Settings

The JSON schema representing the settings for the given integration type, source, and destination service types.

Property	Type	Required
`additionalProperties`	boolean	no
`properties`	object	no
`title`	string	no
`type`	string	no

SDK reference for list-dbaas-integration-settings: golang | Python | Java

CLI: exo api list-dbaas-integration-settings

list-dbaas-integration-types

GET /dbaas-integration-types

[BETA] Get DBaaS integration types

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`dbaas-integration-types`	array of DBaaS Integration Type

Example output

{
  "dbaas-integration-types": [
    {
      "dest-description": "string",
      "dest-service-types": [
        "string"
      ],
      "settings": {
        "additionalProperties": true,
        "properties": {},
        "title": "string",
        "type": "string"
      },
      "source-description": "string",
      "source-service-types": [
        "string"
      ],
      "type": "string"
    }
  ]
}

SDK reference for list-dbaas-integration-types: golang | Python | Java

CLI: exo api list-dbaas-integration-types

get-dbaas-migration-status

Get a DBaaS migration status

GET /dbaas-migration-status/{name}

Get a DBaaS migration status

Path parameters

Name	In	Description
`name`	`path`	Min length: `0`. Max length: `63`.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`details`	array of Details	Migration status per database
`error`	string	Error message in case that migration has failed
`method`	string	Migration method. Empty in case of multiple methods or error
`status`	string	Migration status

Example output

{
  "details": [
    {
      "dbname": "string",
      "error": "string",
      "method": "string",
      "status": "running"
    }
  ],
  "error": "string",
  "method": "string",
  "status": "string"
}

SDK reference for get-dbaas-migration-status: golang | Python | Java

CLI: exo api get-dbaas-migration-status

delete-dbaas-service

Delete a DBaaS service

DELETE /dbaas-service/{name}

Delete a DBaaS service

Path parameters

Name	In	Description
`name`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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: golang | Python | Java

CLI: exo api delete-dbaas-service

detach-dbaas-service-from-endpoint

PUT /dbaas-external-endpoint/{source-service-name}/detach

[BETA] Detach a DBaaS external integration from a service

Path parameters

Name	In	Description
`source-service-name`	`path`	Min length: `0`. Max length: `63`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`integration-id`	string	yes	External Integration ID Must be a valid UUID.

Example

{
  "integration-id": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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 detach-dbaas-service-from-endpoint: golang | Python | Java

CLI: exo api detach-dbaas-service-from-endpoint

get-dbaas-service-logs

Get logs of DBaaS service

POST /dbaas-service-logs/{service-name}

Get logs of DBaaS service

Path parameters

Name	In	Description
`service-name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`limit`	integer	no	How many log entries to receive at most, up to 500 (default: 100) Min: `1`. Max: `500`.
`offset`	string	no	Opaque offset identifier
`sort-order`	string	no	Sort order for log messages (default: desc) Allowed values: `desc`, `asc`.

Example

{
  "limit": 0,
  "offset": "string",
  "sort-order": "desc"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`first-log-offset`	string
`logs`	array of Logs
`offset`	string

Example output

{
  "first-log-offset": "string",
  "logs": [
    {
      "message": "string",
      "node": "string",
      "time": "string",
      "unit": "string"
    }
  ],
  "offset": "string"
}

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

CLI: exo api get-dbaas-service-logs

get-dbaas-service-metrics

Get metrics of DBaaS service

POST /dbaas-service-metrics/{service-name}

Get metrics of DBaaS service

Path parameters

Name	In	Description
`service-name`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`period`	string	no	Metrics time period (default: hour) Allowed values: `hour`, `week`, `year`, `month`, `day`.

Example

{
  "period": "hour"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`metrics`	object

Example output

{
  "metrics": {}
}

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

CLI: exo api get-dbaas-service-metrics

attach-dbaas-service-to-endpoint

PUT /dbaas-external-endpoint/{source-service-name}/attach

[BETA] Create a new DBaaS connection between a DBaaS service and an external service

Path parameters

Name	In	Description
`source-service-name`	`path`	Min length: `0`. Max length: `63`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`dest-endpoint-id`	string	yes	External endpoint id Must be a valid UUID.
`type`	string	yes	External endpoint type Allowed values: `prometheus`, `opensearch`, `rsyslog`, `datadog`, `elasticsearch`.

Example

{
  "dest-endpoint-id": "string",
  "type": "prometheus"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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 attach-dbaas-service-to-endpoint: golang | Python | Java

CLI: exo api attach-dbaas-service-to-endpoint

get-dbaas-service-type

Get a DBaaS service type

GET /dbaas-service-type/{service-type-name}

Get a DBaaS service type

Path parameters

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

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`available-versions`	array[string]	DbaaS service available versions
`default-version`	string	DbaaS service default version
`description`	string	DbaaS service description
`name`	string	DbaaS service name Min length: `0`. Max length: `64`.
`plans`	array of DBaaS plan	DbaaS service plans

Example output

{
  "available-versions": [
    "string"
  ],
  "default-version": "string",
  "description": "string",
  "name": "string",
  "plans": [
    {
      "authorized": true,
      "backup-config": {
        "frequent-interval-minutes": 0,
        "frequent-oldest-age-minutes": 0,
        "infrequent-interval-minutes": 0,
        "infrequent-oldest-age-minutes": 0,
        "interval": 0,
        "max-count": 0,
        "recovery-mode": "string"
      },
      "disk-space": 0,
      "family": "string",
      "max-memory-percent": 0,
      "name": "string",
      "node-count": 0,
      "node-cpu-count": 0,
      "node-memory": 0,
      "zones": [
        "string"
      ]
    }
  ]
}

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

CLI: exo api get-dbaas-service-type

list-dbaas-service-types

DBaaS Service Types

GET /dbaas-service-type

List available service types for DBaaS

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`dbaas-service-types`	array of DBaaS service

Example output

{
  "dbaas-service-types": [
    {
      "available-versions": [
        "string"
      ],
      "default-version": "string",
      "description": "string",
      "name": "string",
      "plans": [
        {
          "authorized": true,
          "backup-config": {
            "frequent-interval-minutes": null,
            "frequent-oldest-age-minutes": null,
            "infrequent-interval-minutes": null,
            "infrequent-oldest-age-minutes": null,
            "interval": null,
            "max-count": null,
            "recovery-mode": null
          },
          "disk-space": 0,
          "family": "string",
          "max-memory-percent": 0,
          "name": "string",
          "node-count": 0,
          "node-cpu-count": 0,
          "node-memory": 0,
          "zones": [
            null
          ]
        }
      ]
    }
  ]
}

SDK reference for list-dbaas-service-types: golang | Python | Java

CLI: exo api list-dbaas-service-types

list-dbaas-services

List DBaaS services

GET /dbaas-service

List DBaaS services

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`dbaas-services`	array of DBaaS Service Common

Example output

{
  "dbaas-services": [
    {
      "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"
        }
      ],
      "name": "string",
      "node-count": 0,
      "node-cpu-count": 0,
      "node-memory": 0,
      "notifications": [
        {
          "level": "warning",
          "message": "string",
          "metadata": {},
          "type": "service_powered_off_removal"
        }
      ],
      "plan": "string",
      "state": "running",
      "termination-protection": true,
      "type": "string",
      "updated-at": "2024-01-01T12:00:00Z",
      "zone": "string"
    }
  ]
}

SDK reference for list-dbaas-services: golang | Python | Java

CLI: exo api list-dbaas-services

get-dbaas-settings-clickhouse

[BETA] Get DBaaS ClickHouse settings

GET /dbaas-settings-clickhouse

null

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`settings`	Settings

Example output

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

Settings

Property	Type	Required	Description
`clickhouse`	Clickhouse	no	ClickHouse configuration values

Clickhouse

ClickHouse configuration values

Property	Type	Required
`additionalProperties`	boolean	no
`properties`	object	no
`title`	string	no
`type`	string	no

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

CLI: exo api get-dbaas-settings-clickhouse

get-dbaas-task

Get a DBaaS task

GET /dbaas-task/{service}/{id}

Get a DBaaS task

Path parameters

Name	In	Description
`service`	`path`	Min length: `0`. Max length: `63`.
`id`	`path`	Must be a valid UUID.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`create-time`	string	ISO 8601 date-time.
`id`	string	Must be a valid UUID.
`result`	string
`result-codes`	array of Result Codes
`success`	boolean
`task-type`	string

Example output

{
  "create-time": "2024-01-01T12:00:00Z",
  "id": "string",
  "result": "string",
  "result-codes": [
    {
      "code": "string",
      "dbname": "string"
    }
  ],
  "success": true,
  "task-type": "string"
}

SDK reference for get-dbaas-task: golang | Python | Java

CLI: exo api get-dbaas-task

create-dbaas-task-migration-check

POST /dbaas-task-migration-check/{service}

Create a DBaaS task to check migration

Path parameters

Name	In	Description
`service`	`path`	Min length: `0`. Max length: `63`.

Request body

Content-Type: application/json

Property	Type	Required	Description
`source-service-uri`	string	yes	Service URI of the source MySQL or PostgreSQL database with admin credentials. Min length: `1`. Max length: `512`.
`ignore-dbs`	string	no	Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment) Min length: `1`. Max length: `2048`.
`method`	string	no	The migration method to be used (currently supported only by MySQL service type) Allowed values: `dump`, `replication`.

Example

{
  "ignore-dbs": "string",
  "method": "dump",
  "source-service-uri": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID Must be a valid UUID.
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`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-task-migration-check: golang | Python | Java

CLI: exo api create-dbaas-task-migration-check

Last updated on July 28, 2026