Exoscale dbaas API
Databases as a Service (DBaaS) provides scalable and fully-managed database solutions with high availability and performance backed by Exoscale's Compute and Storage services.
Exoscale dbaas API is one of 37 APIs that Exoscale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include dbaas. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.
This API exposes 132 operations across 94 paths, and defines 102 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against a single base URL, https://api-{zone}.exoscale.com/v2.
132 operations
94 paths
102 schemas
24 DELETE44 GET31 POST33 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 132
Across 94 paths, the API surfaces 132 operations — 24 DELETE, 44 GET, 31 POST, 33 PUT. Each is listed below with its method, path, parameters, and response codes.
dbaas 132
Databases as a Service (DBaaS) provides scalable and fully-managed database solutions with high availability and performance backed by Exoscale's Compute and Storage services.
DELETE
/dbaas-external-endpoint-opensearch/{endpoint-id}
[BETA] Delete OpenSearch logs external integration endpoint
GET
/dbaas-external-endpoint-opensearch/{endpoint-id}
[BETA] Get OpenSearch Logs external integration endpoint settings
PUT
/dbaas-external-endpoint-opensearch/{endpoint-id}
[BETA] Update OpenSearch Logs external integration endpoint
GET
/dbaas-opensearch/{name}/acl-config
Get DBaaS OpenSearch ACL configuration
PUT
/dbaas-opensearch/{name}/acl-config
Create a DBaaS OpenSearch ACL configuration
POST
/dbaas-valkey/{name}/migration/stop
Stop a DBaaS Valkey migration
PUT
/dbaas-grafana/{name}/maintenance/start
Initiate Grafana maintenance update
POST
/dbaas-postgres/{service}/upgrade-check
Check whether you can upgrade Postgres service to a newer version
PUT
/dbaas-mysql/{service-name}/user/{username}/password/reset
Reset the credentials of a DBaaS mysql user
POST
/dbaas-postgres/{service-name}/connection-pool
Create a DBaaS PostgreSQL connection pool
PUT
/dbaas-mysql/{name}
Update a DBaaS MySQL service
GET
/dbaas-mysql/{name}
Get a DBaaS MySQL service
POST
/dbaas-mysql/{name}
Create a DBaaS MySQL service
DELETE
/dbaas-mysql/{name}
Delete a MySQL service
PUT
/dbaas-thanos/{name}/maintenance/start
Initiate Thanos maintenance update
DELETE
/dbaas-external-endpoint-elasticsearch/{endpoint-id}
[BETA] Delete ElasticSearch logs external integration endpoint
GET
/dbaas-external-endpoint-elasticsearch/{endpoint-id}
[BETA] Get ElasticSearch Logs external integration endpoint settings
PUT
/dbaas-external-endpoint-elasticsearch/{endpoint-id}
[BETA] Update ElasticSearch Logs external integration endpoint
POST
/dbaas-mysql/{service-name}/user
Create a DBaaS MySQL user
GET
/dbaas-service-type
DBaaS Service Types
GET
/dbaas-service
List DBaaS services
POST
/dbaas-external-endpoint-rsyslog/{name}
[BETA] Create RSyslog external integration endpoint
GET
/dbaas-ca-certificate
Get DBaaS CA Certificate
GET
/dbaas-settings-grafana
Get DBaaS Grafana settings
DELETE
/dbaas-postgres/{service-name}/database/{database-name}
Delete a DBaaS Postgres database
POST
/dbaas-postgres/{name}/migration/stop
Stop a DBaaS PostgreSQL migration
GET
/dbaas-kafka/{name}
Get a DBaaS Kafka service
POST
/dbaas-kafka/{name}
Create a DBaaS Kafka service
PUT
/dbaas-kafka/{name}
Update a DBaaS Kafka service
DELETE
/dbaas-kafka/{name}
Delete a Kafka service
POST
/dbaas-kafka/{name}/schema-registry/acl-config
Add a Kafka Schema Registry ACL entry
POST
/dbaas-postgres/{service-name}/user
Create a DBaaS Postgres user
GET
/dbaas-external-integrations/{service-name}
[BETA] List all DBaaS connections between services and external endpoints
GET
/dbaas-external-integration/{integration-id}
[BETA] Get a DBaaS external integration
GET
/dbaas-external-endpoint-types
[BETA] List available external endpoint types and their schemas for DBaaS external integrations
GET
/dbaas-kafka/{service-name}/connect/password/reveal
Reveal the secrets for DBaaS Kafka Connect
DELETE
/dbaas-opensearch/{service-name}/user/{username}
Delete a DBaaS OpenSearch user
GET
/dbaas-external-endpoint-prometheus/{endpoint-id}
[BETA] Get Prometheus external integration endpoint settings
DELETE
/dbaas-external-endpoint-prometheus/{endpoint-id}
[BETA] Delete Prometheus external integration endpoint
PUT
/dbaas-external-endpoint-prometheus/{endpoint-id}
[BETA] Update Prometheus external integration endpoint
POST
/dbaas-kafka/{service-name}/user
Create a DBaaS Kafka user
PUT
/dbaas-valkey/{service-name}/user/{username}/password/reset
Reset the credentials of a DBaaS Valkey user
POST
/dbaas-external-integration-settings-datadog/{integration-id}
[BETA] Manage Datadog integration settings
GET
/dbaas-external-integration-settings-datadog/{integration-id}
[BETA] Get Datadog integration settings
GET
/dbaas-settings-mysql
Get DBaaS MySQL settings
GET
/dbaas-settings-valkey
Get DBaaS Valkey settings
POST
/dbaas-postgres/{service-name}/database
Create a DBaaS Postgres database
GET
/dbaas-settings-thanos
Get DBaaS Thanos settings
POST
/dbaas-opensearch/{service-name}/user
Create a DBaaS OpenSearch user
GET
/dbaas-integration-types
[BETA] Get DBaaS integration types
DELETE
/dbaas-postgres/{service-name}/user/{username}
Delete a DBaaS Postgres user
PUT
/dbaas-postgres/{service-name}/user/{username}/allow-replication
Update access control for one service user
POST
/dbaas-kafka/{name}/topic/acl-config
Add a Kafka topic ACL entry
POST
/dbaas-external-endpoint-opensearch/{name}
[BETA] Create OpenSearch Logs external integration endpoint
DELETE
/dbaas-mysql/{service-name}/database/{database-name}
Delete a DBaaS MySQL database
POST
/dbaas-service-logs/{service-name}
Get logs of DBaaS service
PUT
/dbaas-postgres/{name}/maintenance/start
Initiate PostgreSQL maintenance update
GET
/dbaas-grafana/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS Grafana user
PUT
/dbaas-grafana/{service-name}/user/{username}/password/reset
Reset the credentials of a DBaaS Grafana user
PUT
/dbaas-valkey/{service-name}/user/{username}
Update access control for one DBaaS Valkey service user
DELETE
/dbaas-valkey/{service-name}/user/{username}
Delete a DBaaS Valkey user
DELETE
/dbaas-kafka/{name}/schema-registry/acl-config/{acl-id}
Delete a Kafka ACL entry
DELETE
/dbaas-kafka/{service-name}/user/{username}
Delete a DBaaS kafka user
GET
/dbaas-service-type/{service-type-name}
Get a DBaaS service type
POST
/dbaas-external-endpoint-datadog/{name}
[BETA] Create DataDog external integration endpoint
PUT
/dbaas-mysql/{name}/maintenance/start
Initiate MySQL maintenance update
PUT
/dbaas-opensearch/{service-name}/user/{username}/password/reset
Reset the credentials of a DBaaS OpenSearch user
GET
/dbaas-mysql/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS MySQL user
POST
/dbaas-service-metrics/{service-name}
Get metrics of DBaaS service
PUT
/dbaas-mysql/{name}/enable/writes
Temporarily enable writes for MySQL services in read-only mode due to filled up storage
GET
/dbaas-kafka/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS Kafka user
POST
/dbaas-task-migration-check/{service}
Create a DBaaS task to check migration
DELETE
/dbaas-external-endpoint-datadog/{endpoint-id}
[BETA] Delete DataDog external integration endpoint
GET
/dbaas-external-endpoint-datadog/{endpoint-id}
[BETA] Get DataDog external endpoint settings
PUT
/dbaas-external-endpoint-datadog/{endpoint-id}
[BETA] Update DataDog external integration endpoint
POST
/dbaas-external-endpoint-prometheus/{name}
[BETA] Create Prometheus external integration endpoint
DELETE
/dbaas-integration/{id}
[BETA] Delete a DBaaS Integration
PUT
/dbaas-integration/{id}
[BETA] Update a existing DBaaS integration
GET
/dbaas-integration/{id}
[BETA] Get a DBaaS Integration
GET
/dbaas-integration-settings/{integration-type}/{source-type}/{dest-type}
[BETA] Get DBaaS integration settings
GET
/dbaas-thanos/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS Thanos user
GET
/dbaas-settings-pg
Get DBaaS PostgreSQL settings
DELETE
/dbaas-valkey/{name}
Delete a Valkey service
GET
/dbaas-valkey/{name}
Get a DBaaS Valkey service
POST
/dbaas-valkey/{name}
Create a DBaaS Valkey service
PUT
/dbaas-valkey/{name}
Update a DBaaS Valkey service
POST
/dbaas-mysql/{name}/migration/stop
Stop a DBaaS MySQL migration
GET
/dbaas-external-endpoints
[BETA] List available external endpoints for integrations
PUT
/dbaas-kafka/{name}/maintenance/start
Initiate Kafka maintenance update
PUT
/dbaas-postgres/{service-name}/connection-pool/{connection-pool-name}
Update a DBaaS PostgreSQL connection pool
DELETE
/dbaas-postgres/{service-name}/connection-pool/{connection-pool-name}
Delete a DBaaS PostgreSQL connection pool
GET
/dbaas-thanos/{name}
Get a DBaaS Thanos service
POST
/dbaas-thanos/{name}
Create a DBaaS Thanos service
PUT
/dbaas-thanos/{name}
Update a DBaaS Thanos service
DELETE
/dbaas-thanos/{name}
Delete a Thanos service
GET
/dbaas-migration-status/{name}
Get a DBaaS migration status
DELETE
/dbaas-mysql/{service-name}/user/{username}
Delete a DBaaS MySQL user
DELETE
/dbaas-service/{name}
Delete a DBaaS service
POST
/dbaas-mysql/{service-name}/database
Create a DBaaS MySQL database
GET
/dbaas-settings-kafka
Get DBaaS Kafka settings
GET
/dbaas-postgres/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS Postgres user
GET
/dbaas-settings-opensearch
Get DBaaS OpenSearch settings
PUT
/dbaas-external-endpoint/{source-service-name}/attach
[BETA] Create a new DBaaS connection between a DBaaS service and an external service
DELETE
/dbaas-grafana/{name}
Delete a Grafana service
GET
/dbaas-grafana/{name}
Get a DBaaS Grafana service
PUT
/dbaas-grafana/{name}
Update a DBaaS Grafana service
POST
/dbaas-grafana/{name}
Create a DBaaS Grafana service
DELETE
/dbaas-external-endpoint-rsyslog/{endpoint-id}
[BETA] Delete RSyslog external integration endpoint
PUT
/dbaas-external-endpoint-rsyslog/{endpoint-id}
[BETA] Update RSyslog external integration endpoint
GET
/dbaas-external-endpoint-rsyslog/{endpoint-id}
[BETA] Get RSyslog external integration endpoint settings
POST
/dbaas-external-endpoint-elasticsearch/{name}
[BETA] Create ElasticSearch Logs external integration endpoint
PUT
/dbaas-opensearch/{name}/maintenance/start
Initiate OpenSearch maintenance update
GET
/dbaas-kafka/{name}/acl-config
Get DBaaS kafka ACL configuration
PUT
/dbaas-kafka/{service-name}/user/{username}/password/reset
Reset the credentials of a DBaaS Kafka user
GET
/dbaas-opensearch/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS OpenSearch user
PUT
/dbaas-valkey/{name}/maintenance/start
Initiate Valkey maintenance update
POST
/dbaas-opensearch/{name}
Create a DBaaS OpenSearch service
GET
/dbaas-opensearch/{name}
Get a DBaaS OpenSearch service
DELETE
/dbaas-opensearch/{name}
Delete a OpenSearch service
PUT
/dbaas-opensearch/{name}
Update a DBaaS OpenSearch service
PUT
/dbaas-external-endpoint/{source-service-name}/detach
[BETA] Detach a DBaaS external integration from a service
GET
/dbaas-valkey/{service-name}/user/{username}/password/reveal
Reveal the secrets of a DBaaS Valkey user
PUT
/dbaas-postgres/{name}
Update a DBaaS PostgreSQL service
GET
/dbaas-postgres/{name}
Get a DBaaS PostgreSQL service
POST
/dbaas-postgres/{name}
Create a DBaaS PostgreSQL service
DELETE
/dbaas-postgres/{name}
Delete a Postgres service
POST
/dbaas-valkey/{service-name}/user
Create a DBaaS Valkey user
GET
/dbaas-valkey/{service-name}/user
List DBaaS Valkey users with ACL configuration
POST
/dbaas-integration
[BETA] Create a new DBaaS integration between two services
GET
/dbaas-task/{service}/{id}
Get a DBaaS task
DELETE
/dbaas-kafka/{name}/topic/acl-config/{acl-id}
Delete a Kafka ACL entry
PUT
/dbaas-postgres/{service-name}/user/{username}/password/reset
Reset the credentials of a DBaaS Postgres user
Schemas 102
The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are json-schema-kafka (42 properties), json-schema-pg (41 properties), json-schema-opensearch (39 properties), dbaas-service-pg (36 properties). Each schema is shown below with its type and property counts.
enum-integration-types
string
dbaas-endpoint-datadog-input-create
object
1 property
dbaas-postgres-users
object
1 property
enum-external-endpoint-types
string
dbaas-service-logs
object
3 properties
dbaas-external-integration
object
Integrations with other services
8 properties
4 required
dbaas-valkey-users
object
1 property
dbaas-service-valkey
object
26 properties
4 required
enum-component-route
string
dbaas-external-endpoint-rsyslog-output
object
4 properties
dbaas-plan
object
DBaaS plan
10 properties
enum-pg-variant
string
dbaas-pg-pool-username
string
dbaas-user-valkey-secrets
object
Valkey User secrets
2 properties
dbaas-endpoint-opensearch-output
object
4 properties
dbaas-valkey-user-access-control
object
4 properties
enum-pg-synchronous-replication
string
dbaas-pg-pool-name
string
dbaas-service-type
object
DBaaS service
5 properties
json-schema-timescaledb
object
System-wide settings for the timescaledb extension
1 property
dbaas-service-common
object
14 properties
3 required
dbaas-service-notification
object
Service notifications
4 properties
4 required
dbaas-service-grafana
object
27 properties
4 required
dbaas-service-name
string
dbaas-service-backup
object
List of backups for the service
3 properties
3 required
json-schema-pglookout
object
System-wide settings for pglookout.
1 property
enum-mysql-authentication-plugin
string
dbaas-backup-config
object
DBaaS plan backup config
7 properties
dbaas-user-postgres-secrets
object
Postgres User secrets
2 properties
dbaas-endpoint-prometheus-payload
object
1 property
dbaas-endpoint-elasticsearch-input-update
object
1 property
dbaas-datadog-tag
object
2 properties
1 required
dbaas-opensearch-acl-config
object
3 properties
json-schema-opensearch
object
39 properties
dbaas-endpoint-elasticsearch-optional-fields
object
4 properties
json-schema-kafka
object
42 properties
dbaas-kafka-schema-registry-acl-entry
object
4 properties
3 required
dbaas-pg-target-versions
string
json-schema-valkey
object
11 properties
enum-datadog-site
string
dbaas-kafka-acls
object
2 properties
dbaas-integration-settings-datadog
object
2 properties
json-schema-thanos
object
3 properties
enum-sort-order
string
dbaas-endpoint-opensearch-optional-fields
object
4 properties
json-schema-kafka-rest
object
10 properties
dbaas-user-grafana-secrets
object
Grafana User secrets
2 properties
dbaas-service-thanos
object
25 properties
4 required
dbaas-user-username
string
dbaas-external-endpoint
object
3 properties
dbaas-user-kafka-secrets
object
Kafka User secrets
5 properties
dbaas-user-thanos-secrets
object
Thanos User secrets
2 properties
enum-component-usage
string
dbaas-mysql-user-password
string
dbaas-endpoint-external-prometheus-output
object
4 properties
dbaas-user-opensearch-secrets
object
Opensearch User secrets
2 properties
json-schema-schema-registry
object
2 properties
enum-opensearch-rule-permission
string
dbaas-user-mysql-secrets
object
MySQL User secrets
2 properties
dbaas-endpoint-rsyslog-input-create
object
1 property
enum-migration-status
string
dbaas-task
object
6 properties
dbaas-user-password
string
json-schema-grafana
object
31 properties
enum-migration-method
string
enum-rsyslog-format
string
enum-pg-pool-mode
string
json-schema-kafka-connect
object
16 properties
dbaas-endpoint-rsyslog-input-update
object
1 property
dbaas-pg-database-name
string
dbaas-valkey-user
object
3 properties
1 required
json-schema-pgbouncer
object
System-wide settings for pgbouncer.
10 properties
enum-kafka-auth-method
string
dbaas-pg-pool-size
integer
dbaas-integration-type
object
6 properties
dbaas-service-kafka
object
33 properties
4 required
dbaas-service-opensearch
object
32 properties
4 required
dbaas-endpoint-datadog-input-update
object
1 property
dbaas-integration
object
9 properties
dbaas-node-state
object
Automatic maintenance settings
4 properties
2 required
dbaas-database-name
string
dbaas-external-endpoint-datadog-output
object
4 properties
dbaas-node-state-progress-update
object
Extra information regarding the progress for current state
6 properties
2 required
operation
object
Operation
5 properties
enum-service-state
string
dbaas-service-update
object
Update waiting to be installed
4 properties
dbaas-endpoint-opensearch-input-create
object
1 property
dbaas-endpoint-elasticsearch-input-create
object
1 property
dbaas-mysql-database-name
string
dbaas-endpoint-elasticsearch-output
object
4 properties
dbaas-service-maintenance
object
Automatic maintenance settings
3 properties
3 required
dbaas-endpoint-rsyslog-optional-fields
object
7 properties
dbaas-kafka-acl-id
string
json-schema-mysql
object
31 properties
dbaas-service-pg
object
36 properties
4 required
dbaas-migration-status
object
4 properties
dbaas-service-type-name
string
dbaas-user-kafka-connect-secrets
object
Kafka Connect secrets
2 properties
dbaas-service-mysql
object
28 properties
4 required
dbaas-endpoint-opensearch-input-update
object
1 property
json-schema-pg
object
41 properties
dbaas-kafka-topic-acl-entry
object
4 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Exoscale 12
Other APIs Exoscale publishes across the network.
Exoscale ai-api-key API
Exoscale anti-affinity-group API
Exoscale api-key API
Exoscale block-storage API
Exoscale ccm API
Exoscale cluster API
Exoscale compute API
Exoscale crypto API
Exoscale deploy-target API
Exoscale deployment API
Exoscale domain API
Exoscale elastic-ip API
#dbaas