dbaas

get-dbaas-settings-pg

[`GET /dbaas-settings-pg`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-settings-pg)

Get DBaaS PostgreSQL settings

update-dbaas-pg-connection-pool

[`PUT /dbaas-postgres/<service-name>/connection-pool/<connection-pool-name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-pg-connection-pool)

Update a DBaaS PostgreSQL connection pool

Parameters:

  • parameters.username

  • parameters.mode

  • parameters.connection_pool_name

  • parameters.service_name

  • parameters.size

  • parameters.database_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-service-kafka

[`GET /dbaas-kafka/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-kafka)

Get a DBaaS Kafka service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-service

[`DELETE /dbaas-service/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service)

Delete a DBaaS service

Parameters:

  • parameters.name

get-dbaas-kafka-acl-config

[`GET /dbaas-kafka/<name>/acl-config`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-kafka-acl-config)

Get DBaaS kafka ACL configuration

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-service-grafana

[`DELETE /dbaas-grafana/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service-grafana)

Delete a Grafana service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

stop-dbaas-mysql-migration

[`POST /dbaas-mysql/<name>/migration/stop`](https://openapi-v2.exoscale.com/operation/operation-stop-dbaas-mysql-migration)

Stop a DBaaS MySQL migration

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

update-dbaas-service-mysql

[`PUT /dbaas-mysql/<name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-service-mysql)

Update a DBaaS MySQL service

Parameters:

  • parameters.ip_filter

  • parameters.binlog_retention_period

  • parameters.backup_schedule

  • parameters.name

  • parameters.mysql_settings

  • parameters.migration

  • parameters.maintenance

  • parameters.plan

  • parameters.termination_protection

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-kafka-topic-acl-config

[`DELETE /dbaas-kafka/<name>/topic/acl-config/<acl-id>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-kafka-topic-acl-config)

Delete a Kafka ACL entry

Parameters:

  • parameters.acl_id

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-task

[`GET /dbaas-task/<service>/<id>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-task)

Get a DBaaS task

Parameters:

  • parameters.id

  • parameters.service

start-dbaas-kafka-maintenance

[`PUT /dbaas-kafka/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-kafka-maintenance)

Initiate Kafka maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

list-dbaas-integration-types

[`GET /dbaas-integration-types`](https://openapi-v2.exoscale.com/operation/operation-list-dbaas-integration-types)

Get DBaaS integration types

list-dbaas-integration-settings

[`GET /dbaas-integration-settings/<integration-type>/<source-type>/<dest-type>`](https://openapi-v2.exoscale.com/operation/operation-list-dbaas-integration-settings)

Get DBaaS integration settings

Parameters:

  • parameters.source_type

  • parameters.dest_type

  • parameters.integration_type

delete-dbaas-integration

[`DELETE /dbaas-integration/<id>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-integration)

Delete a DBaaS Integration

Parameters:

  • parameters.id

Resources:

  • resources.dbaas_integration.status

  • resources.dbaas_integration.description

create-dbaas-task-migration-check

[`POST /dbaas-task-migration-check/<service>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-task-migration-check)

Parameters:

  • parameters.method

  • parameters.ignore_dbs

  • parameters.source_service_uri

  • parameters.service

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-kafka-schema-registry-acl-config

[`DELETE /dbaas-kafka/<name>/schema-registry/acl-config/<acl-id>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-kafka-schema-registry-acl-config)

Delete a Kafka ACL entry

Parameters:

  • parameters.acl_id

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-service-opensearch

[`POST /dbaas-opensearch/<name>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-service-opensearch)

Create a DBaaS OpenSearch service

Parameters:

  • parameters.ip_filter

  • parameters.keep_index_refresh_interval

  • parameters.max_index_count

  • parameters.opensearch_dashboards

  • parameters.name

  • parameters.opensearch_settings

  • parameters.recovery_backup_name

  • parameters.version

  • parameters.maintenance

  • parameters.plan

  • parameters.index_patterns

  • parameters.fork_from_service

  • parameters.index_template

  • parameters.termination_protection

create-dbaas-service-kafka

[`POST /dbaas-kafka/<name>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-service-kafka)

Create a DBaaS Kafka service

Parameters:

  • parameters.ip_filter

  • parameters.kafka_rest_settings

  • parameters.kafka_connect_settings

  • parameters.kafka_connect_enabled

  • parameters.kafka_settings

  • parameters.name

  • parameters.schema_registry_enabled

  • parameters.version

  • parameters.maintenance

  • parameters.plan

  • parameters.schema_registry_settings

  • parameters.termination_protection

  • parameters.authentication_methods

  • parameters.kafka_rest_enabled

update-dbaas-service-kafka

[`PUT /dbaas-kafka/<name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-service-kafka)

Update a DBaaS Kafka service

Parameters:

  • parameters.ip_filter

  • parameters.kafka_rest_settings

  • parameters.kafka_connect_settings

  • parameters.kafka_connect_enabled

  • parameters.kafka_settings

  • parameters.name

  • parameters.schema_registry_enabled

  • parameters.maintenance

  • parameters.plan

  • parameters.schema_registry_settings

  • parameters.termination_protection

  • parameters.authentication_methods

  • parameters.kafka_rest_enabled

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-opensearch-user

[`DELETE /dbaas-opensearch/<service-name>/user/<username>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-opensearch-user)

Delete a DBaaS OpenSearch user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-kafka-user

[`DELETE /dbaas-kafka/<service-name>/user/<username>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-kafka-user)

Delete a DBaaS kafka user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-settings-mysql

[`GET /dbaas-settings-mysql`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-settings-mysql)

Get DBaaS MySQL settings

list-dbaas-service-types

[`GET /dbaas-service-type`](https://openapi-v2.exoscale.com/operation/operation-list-dbaas-service-types)

DBaaS Service Types

update-dbaas-service-pg

[`PUT /dbaas-postgres/<name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-service-pg)

Update a DBaaS PostgreSQL service

Parameters:

  • parameters.ip_filter

  • parameters.pglookout_settings

  • parameters.synchronous_replication

  • parameters.pg_settings

  • parameters.backup_schedule

  • parameters.work_mem

  • parameters.name

  • parameters.pgbouncer_settings

  • parameters.migration

  • parameters.version

  • parameters.maintenance

  • parameters.plan

  • parameters.termination_protection

  • parameters.shared_buffers_percentage

  • parameters.variant

  • parameters.timescaledb_settings

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-settings-kafka

[`GET /dbaas-settings-kafka`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-settings-kafka)

Get DBaaS Kafka settings

update-dbaas-postgres-allow-replication

[`PUT /dbaas-postgres/<service-name>/user/<username>/allow-replication`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-postgres-allow-replication)

Update access control for one service user

Parameters:

  • parameters.username

  • parameters.service_name

  • parameters.allow_replication

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

update-dbaas-integration

[`PUT /dbaas-integration/<id>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-integration)

Update a existing DBaaS integration

Parameters:

  • parameters.settings

  • parameters.id

Resources:

  • resources.dbaas_integration.status

  • resources.dbaas_integration.description

delete-dbaas-mysql-database

[`DELETE /dbaas-mysql/<service-name>/database/<database-name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-mysql-database)

Delete a DBaaS MySQL database

Parameters:

  • parameters.service_name

  • parameters.database_name

get-dbaas-service-grafana

[`GET /dbaas-grafana/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-grafana)

Get a DBaaS Grafana service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-opensearch-acl-config

[`GET /dbaas-opensearch/<name>/acl-config`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-opensearch-acl-config)

Get DBaaS OpenSearch ACL configuration

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

stop-dbaas-pg-migration

[`POST /dbaas-postgres/<name>/migration/stop`](https://openapi-v2.exoscale.com/operation/operation-stop-dbaas-pg-migration)

Stop a DBaaS PostgreSQL migration

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-kafka-topic-acl-config

[`POST /dbaas-kafka/<name>/topic/acl-config`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-kafka-topic-acl-config)

Add a Kafka topic ACL entry

Parameters:

  • parameters.username

  • parameters.name

  • parameters.permission

  • parameters.topic

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-integration

[`GET /dbaas-integration/<id>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-integration)

Get a DBaaS Integration

Parameters:

  • parameters.id

Resources:

  • resources.dbaas_integration.status

  • resources.dbaas_integration.description

get-dbaas-service-metrics

[`POST /dbaas-service-metrics/<service-name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-metrics)

Get metrics of DBaaS service

Parameters:

  • parameters.service_name

  • parameters.period

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-mysql-database

[`POST /dbaas-mysql/<service-name>/database`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-mysql-database)

Create a DBaaS MySQL database

Parameters:

  • parameters.service_name

  • parameters.database_name

create-dbaas-kafka-user

[`POST /dbaas-kafka/<service-name>/user`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-kafka-user)

Create a DBaaS Kafka user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

update-dbaas-service-grafana

[`PUT /dbaas-grafana/<name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-service-grafana)

Update a DBaaS Grafana service

Parameters:

  • parameters.ip_filter

  • parameters.name

  • parameters.maintenance

  • parameters.plan

  • parameters.termination_protection

  • parameters.grafana_settings

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-settings-opensearch

[`GET /dbaas-settings-opensearch`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-settings-opensearch)

Get DBaaS OpenSearch settings

reset-dbaas-mysql-user-password

[`PUT /dbaas-mysql/<service-name>/user/<username>/password/reset`](https://openapi-v2.exoscale.com/operation/operation-reset-dbaas-mysql-user-password)

Reset the credentials of a DBaaS mysql user

Parameters:

  • parameters.authentication

  • parameters.username

  • parameters.service_name

  • parameters.password

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reveal-dbaas-mysql-user-password

[`GET /dbaas-mysql/<service-name>/user/<username>/password/reveal`](https://openapi-v2.exoscale.com/operation/operation-reveal-dbaas-mysql-user-password)

Reveal the secrets of a DBaaS MySQL user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-postgres-user

[`POST /dbaas-postgres/<service-name>/user`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-postgres-user)

Create a DBaaS Postgres user

Parameters:

  • parameters.username

  • parameters.service_name

  • parameters.allow_replication

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-mysql-maintenance

[`PUT /dbaas-mysql/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-mysql-maintenance)

Initiate MySQL maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-pg-maintenance

[`PUT /dbaas-postgres/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-pg-maintenance)

Initiate PostgreSQL maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-service-mysql

[`GET /dbaas-mysql/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-mysql)

Get a DBaaS MySQL service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-mysql-user

[`POST /dbaas-mysql/<service-name>/user`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-mysql-user)

Create a DBaaS MySQL user

Parameters:

  • parameters.authentication

  • parameters.username

  • parameters.service_name

create-dbaas-pg-upgrade-check

[`POST /dbaas-postgres/<service>/upgrade-check`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-pg-upgrade-check)

Parameters:

  • parameters.target_version

  • parameters.service

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-service-mysql

[`POST /dbaas-mysql/<name>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-service-mysql)

Create a DBaaS MySQL service

Parameters:

  • parameters.ip_filter

  • parameters.admin_password

  • parameters.binlog_retention_period

  • parameters.backup_schedule

  • parameters.name

  • parameters.mysql_settings

  • parameters.admin_username

  • parameters.migration

  • parameters.version

  • parameters.maintenance

  • parameters.plan

  • parameters.recovery_backup_time

  • parameters.fork_from_service

  • parameters.integrations

  • parameters.termination_protection

get-dbaas-service-type

[`GET /dbaas-service-type/<service-type-name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-type)

Get a DBaaS service type

Parameters:

  • parameters.service_type_name

get-dbaas-service-pg

[`GET /dbaas-postgres/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-pg)

Get a DBaaS PostgreSQL service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-kafka-schema-registry-acl-config

[`POST /dbaas-kafka/<name>/schema-registry/acl-config`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-kafka-schema-registry-acl-config)

Add a Kafka Schema Registry ACL entry

Parameters:

  • parameters.resource

  • parameters.username

  • parameters.name

  • parameters.permission

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reset-dbaas-kafka-user-password

[`PUT /dbaas-kafka/<service-name>/user/<username>/password/reset`](https://openapi-v2.exoscale.com/operation/operation-reset-dbaas-kafka-user-password)

Reset the credentials of a DBaaS Kafka user

Parameters:

  • parameters.username

  • parameters.service_name

  • parameters.password

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reveal-dbaas-kafka-user-password

[`GET /dbaas-kafka/<service-name>/user/<username>/password/reveal`](https://openapi-v2.exoscale.com/operation/operation-reveal-dbaas-kafka-user-password)

Reveal the secrets of a DBaaS Kafka user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-mysql-user

[`DELETE /dbaas-mysql/<service-name>/user/<username>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-mysql-user)

Delete a DBaaS MySQL user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-service-opensearch

[`GET /dbaas-opensearch/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-opensearch)

Get a DBaaS OpenSearch service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reset-dbaas-opensearch-user-password

[`PUT /dbaas-opensearch/<service-name>/user/<username>/password/reset`](https://openapi-v2.exoscale.com/operation/operation-reset-dbaas-opensearch-user-password)

Reset the credentials of a DBaaS OpenSearch user

Parameters:

  • parameters.username

  • parameters.service_name

  • parameters.password

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reveal-dbaas-opensearch-user-password

[`GET /dbaas-opensearch/<service-name>/user/<username>/password/reveal`](https://openapi-v2.exoscale.com/operation/operation-reveal-dbaas-opensearch-user-password)

Reveal the secrets of a DBaaS OpenSearch user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-service-pg

[`POST /dbaas-postgres/<name>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-service-pg)

Create a DBaaS PostgreSQL service

Parameters:

  • parameters.ip_filter

  • parameters.pglookout_settings

  • parameters.admin_password

  • parameters.synchronous_replication

  • parameters.pg_settings

  • parameters.backup_schedule

  • parameters.work_mem

  • parameters.name

  • parameters.admin_username

  • parameters.pgbouncer_settings

  • parameters.migration

  • parameters.version

  • parameters.maintenance

  • parameters.plan

  • parameters.recovery_backup_time

  • parameters.fork_from_service

  • parameters.integrations

  • parameters.termination_protection

  • parameters.shared_buffers_percentage

  • parameters.variant

  • parameters.timescaledb_settings

list-dbaas-services

[`GET /dbaas-service`](https://openapi-v2.exoscale.com/operation/operation-list-dbaas-services)

List DBaaS services

get-dbaas-service-logs

[`POST /dbaas-service-logs/<service-name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-logs)

Get logs of DBaaS service

Parameters:

  • parameters.sort_order

  • parameters.offset

  • parameters.limit

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-service-pg

[`DELETE /dbaas-postgres/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service-pg)

Delete a Postgres service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-pg-connection-pool

[`DELETE /dbaas-postgres/<service-name>/connection-pool/<connection-pool-name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-pg-connection-pool)

Delete a DBaaS PostgreSQL connection pool

Parameters:

  • parameters.connection_pool_name

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-settings-grafana

[`GET /dbaas-settings-grafana`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-settings-grafana)

Get DBaaS Grafana settings

create-dbaas-pg-connection-pool

[`POST /dbaas-postgres/<service-name>/connection-pool`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-pg-connection-pool)

Create a DBaaS PostgreSQL connection pool

Parameters:

  • parameters.username

  • parameters.mode

  • parameters.name

  • parameters.service_name

  • parameters.size

  • parameters.database_name

create-dbaas-integration

[`POST /dbaas-integration`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-integration)

Create a new DBaaS integration between two services

Parameters:

  • parameters.settings

  • parameters.source_service

  • parameters.dest_service

  • parameters.integration_type

get-dbaas-ca-certificate

[`GET /dbaas-ca-certificate`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-ca-certificate)

Get DBaaS CA Certificate

delete-dbaas-postgres-user

[`DELETE /dbaas-postgres/<service-name>/user/<username>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-postgres-user)

Delete a DBaaS Postgres user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-migration-status

[`GET /dbaas-migration-status/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-migration-status)

Get a DBaaS migration status

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-service-opensearch

[`DELETE /dbaas-opensearch/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service-opensearch)

Delete a OpenSearch service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-pg-database

[`POST /dbaas-postgres/<service-name>/database`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-pg-database)

Create a DBaaS Postgres database

Parameters:

  • parameters.lc_ctype

  • parameters.service_name

  • parameters.database_name

  • parameters.lc_collate

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-service-grafana

[`POST /dbaas-grafana/<name>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-service-grafana)

Parameters:

  • parameters.ip_filter

  • parameters.name

  • parameters.maintenance

  • parameters.plan

  • parameters.fork_from_service

  • parameters.termination_protection

  • parameters.grafana_settings

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-opensearch-maintenance

[`PUT /dbaas-opensearch/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-opensearch-maintenance)

Initiate OpenSearch maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

update-dbaas-opensearch-acl-config

[`PUT /dbaas-opensearch/<name>/acl-config`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-opensearch-acl-config)

Create a DBaaS OpenSearch ACL configuration

Parameters:

  • parameters.extended_acl_enabled

  • parameters.acl_enabled

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reset-dbaas-postgres-user-password

[`PUT /dbaas-postgres/<service-name>/user/<username>/password/reset`](https://openapi-v2.exoscale.com/operation/operation-reset-dbaas-postgres-user-password)

Reset the credentials of a DBaaS Postgres user

Parameters:

  • parameters.username

  • parameters.service_name

  • parameters.password

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reveal-dbaas-postgres-user-password

[`GET /dbaas-postgres/<service-name>/user/<username>/password/reveal`](https://openapi-v2.exoscale.com/operation/operation-reveal-dbaas-postgres-user-password)

Reveal the secrets of a DBaaS Postgres user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-grafana-maintenance

[`PUT /dbaas-grafana/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-grafana-maintenance)

Initiate Grafana maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-service-kafka

[`DELETE /dbaas-kafka/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service-kafka)

Delete a Kafka service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-pg-database

[`DELETE /dbaas-postgres/<service-name>/database/<database-name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-pg-database)

Delete a DBaaS Postgres database

Parameters:

  • parameters.service_name

  • parameters.database_name

create-dbaas-opensearch-user

[`POST /dbaas-opensearch/<service-name>/user`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-opensearch-user)

Create a DBaaS OpenSearch user

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

update-dbaas-service-opensearch

[`PUT /dbaas-opensearch/<name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-service-opensearch)

Update a DBaaS OpenSearch service

Parameters:

  • parameters.ip_filter

  • parameters.keep_index_refresh_interval

  • parameters.max_index_count

  • parameters.opensearch_dashboards

  • parameters.name

  • parameters.opensearch_settings

  • parameters.version

  • parameters.maintenance

  • parameters.plan

  • parameters.index_patterns

  • parameters.index_template

  • parameters.termination_protection

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

delete-dbaas-service-mysql

[`DELETE /dbaas-mysql/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service-mysql)

Delete a MySQL service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

get-dbaas-service-valkey

[`GET /dbaas-valkey/<name>`](https://openapi-v2.exoscale.com/operation/operation-get-dbaas-service-valkey)

Get a DBaaS Valkey service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-service-valkey

[`POST /dbaas-valkey/<name>`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-service-valkey)

Create a DBaaS Valkey service

Parameters:

  • parameters.ip_filter

  • parameters.valkey_settings

  • parameters.name

  • parameters.recovery_backup_name

  • parameters.migration

  • parameters.maintenance

  • parameters.plan

  • parameters.fork_from_service

  • parameters.termination_protection

delete-dbaas-service-valkey

[`DELETE /dbaas-valkey/<name>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-service-valkey)

Delete a Valkey service

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

update-dbaas-service-valkey

[`PUT /dbaas-valkey/<name>`](https://openapi-v2.exoscale.com/operation/operation-update-dbaas-service-valkey)

Update a DBaaS Valkey service

Parameters:

  • parameters.ip_filter

  • parameters.valkey_settings

  • parameters.name

  • parameters.migration

  • parameters.maintenance

  • parameters.plan

  • parameters.termination_protection

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

stop-dbaas-valkey-migration

[`POST /dbaas-valkey/<name>/migration/stop`](https://openapi-v2.exoscale.com/operation/operation-stop-dbaas-valkey-migration)

Stop a DBaaS Valkey migration

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-valkey-maintenance

[`PUT /dbaas-valkey/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-valkey-maintenance)

Initiate Valkey maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

create-dbaas-valkey-user

[`POST /dbaas-valkey/<service-name>/user`](https://openapi-v2.exoscale.com/operation/operation-create-dbaas-valkey-user)

Create a DBaaS Valkey user

Parameters:

  • parameters.authentication

  • parameters.username

  • parameters.service_name

delete-dbaas-valkey-user

[`DELETE /dbaas-valkey/<service-name>/user/<username>`](https://openapi-v2.exoscale.com/operation/operation-delete-dbaas-valkey-user)

Delete a DBaaS Valkey user

Parameters:

  • parameters.username

  • parameters.service_name

reset-dbaas-valkey-user-password

[`PUT /dbaas-valkey/<service-name>/user/<username>/password/reset`](https://openapi-v2.exoscale.com/operation/operation-reset-dbaas-valkey-user-password)

Reset the credentials of a DBaaS Valkey user

Parameters:

  • parameters.authentication

  • parameters.username

  • parameters.service_name

  • parameters.password

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

reveal-dbaas-valkey-user-password

[`GET /dbaas-valkey/<service-name>/user/<username>/password/reveal`](https://openapi-v2.exoscale.com/operation/operation-reveal-dbaas-valkey-user-password)

Parameters:

  • parameters.username

  • parameters.service_name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-valkey-maintenance

[`PUT /dbaas-valkey/<name>/maintenance/start`](https://openapi-v2.exoscale.com/operation/operation-start-dbaas-valkey-maintenance)

Initiate Valkey maintenance update

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count

start-dbaas-redis-to-valkey-upgrade

PUT /dbaas-redis/<name>/upgrade-type

Initiate upgrade from Redis to Valkey

Parameters:

  • parameters.name

Resources:

  • resources.dbaas_service.name
  • resources.dbaas_service.type
  • resources.dbaas_service.state
  • resources.dbaas_service.zone
  • resources.dbaas_service.plan
  • resources.dbaas_service.node_count