How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scaleway Database Instances API

A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: **High-Availability (HA)**, with a main node and one replica, and **standalone** with a main node. The HA standby node is linked to the main node, using synchronous replication. Synchronous replication offers the ability to confirm that all changes intended by a transaction have been transferred and applied to the synchronous replica node, providing durability to the data.**Note**: HA standby nodes are not accessible to users unless the main node becomes unavailable and the standby takes over. If you wish to run queries on a read-only node, you can use [Read Replicas](#path-read-replicas-create-a-read-replica)Read Replicas can be used for certain read-only workflows such as Business Intelligence, or for a read-only scaling of your application. Read Replicas use asynchronous replication to replicate data from the main node.

Scaleway Database Instances API is one of 74 APIs that Scaleway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Database Instances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 14 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.scaleway.com.

17 operations 14 paths 20 schemas 1 DELETE7 GET1 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://api.scaleway.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Scaleway Database Instances API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (scaleway).

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 7 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Database Instances 17

A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: High-Availability (HA), with a main no…

GET
/rdb/v1/regions/{region}/instances
List Database Instances
ListInstances 9 params → 200
POST
/rdb/v1/regions/{region}/instances
Create a Database Instance
CreateInstance 1 param body → 200
GET
/rdb/v1/regions/{region}/instances/{instance_id}
Get a Database Instance
GetInstance 2 params → 200
PATCH
/rdb/v1/regions/{region}/instances/{instance_id}
Update a Database Instance
UpdateInstance 2 params body → 200
DELETE
/rdb/v1/regions/{region}/instances/{instance_id}
Delete a Database Instance
DeleteInstance 2 params → 200
POST
/rdb/v1/regions/{region}/instances/{instance_id}/apply-maintenance
Apply Database Instance maintenance
ApplyInstanceMaintenance 2 params body → 200
GET
/rdb/v1/regions/{region}/instances/{instance_id}/certificate
Get the TLS certificate of a Database Instance
GetInstanceCertificate 2 params → 200
POST
/rdb/v1/regions/{region}/instances/{instance_id}/clone
Clone a Database Instance
CloneInstance 2 params body → 200
GET
/rdb/v1/regions/{region}/instances/{instance_id}/logs
List available logs of a Database Instance
ListInstanceLogs 3 params → 200
GET
/rdb/v1/regions/{region}/instances/{instance_id}/logs-details
List remote Database Instance logs details
ListInstanceLogsDetails 2 params → 200
GET
/rdb/v1/regions/{region}/instances/{instance_id}/metricsdeprecated
[deprecated] Get Database Instance metrics
GetInstanceMetrics 5 params → 200
POST
/rdb/v1/regions/{region}/instances/{instance_id}/prepare-logs
Prepare logs of a Database Instance
PrepareInstanceLogs 2 params body → 200
POST
/rdb/v1/regions/{region}/instances/{instance_id}/purge-logs
Purge remote Database Instance logs
PurgeInstanceLogs 2 params body → 204
POST
/rdb/v1/regions/{region}/instances/{instance_id}/renew-certificate
Renew the TLS certificate of a Database Instance
RenewInstanceCertificate 2 params body → 204
POST
/rdb/v1/regions/{region}/instances/{instance_id}/restart
Restart Database Instance
RestartInstance 2 params body → 200
POST
/rdb/v1/regions/{region}/instances/{instance_id}/upgrade
Upgrade a Database Instance
UpgradeInstance 2 params body → 200
GET
/rdb/v1/regions/{region}/logs/{instance_log_id}
Get given logs of a Database Instance
GetInstanceLog 2 params → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are scaleway.rdb.v1.Instance (23 properties), scaleway.rdb.v1.Endpoint (8 properties), scaleway.rdb.v1.Maintenance (7 properties), scaleway.rdb.v1.InstanceLog (7 properties). Each schema is shown below with its type and property counts.

google.protobuf.Int32Value
integer
scaleway.rdb.v1.InstanceSetting
object
2 properties
scaleway.rdb.v1.EndpointSpec
object
2 properties
scaleway.rdb.v1.PrepareInstanceLogsResponse
object
1 property
scaleway.rdb.v1.StorageClass
string
scaleway.rdb.v1.ListInstanceLogsResponse
object
1 property
scaleway.rdb.v1.Instance
object
23 properties
scaleway.rdb.v1.ListInstanceLogsDetailsResponse.InstanceLogDetail
object
2 properties
scaleway.rdb.v1.ListInstancesResponse
object
2 properties
scaleway.rdb.v1.Maintenance
object
7 properties
scaleway.rdb.v1.UpgradableVersion
object
4 properties
scaleway.std.File
object
3 properties
scaleway.rdb.v1.ListInstanceLogsDetailsResponse
object
1 property
scaleway.rdb.v1.Volume.Type
string
scaleway.rdb.v1.InstanceMetrics
object
1 property
scaleway.rdb.v1.InstanceLog
object
7 properties
scaleway.rdb.v1.Endpoint
object
8 properties
scaleway.std.TimeSeries
object
3 properties
scaleway.std.TimeSeries.Point
array
scaleway.rdb.v1.ReadReplica
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scaleway-database-instances-api-openapi.yml Raw ↑

Other APIs Scaleway publishes across the network.

Scaleway Generative APIs
Scaleway Access Control List API
Scaleway ACLs API
Scaleway Alert Subscribers API
Scaleway API Keys API
Scaleway Applications API
Scaleway Backends API
Scaleway Backups API
Scaleway Blocklist API
Scaleway Certificate API
Scaleway Cluster types API
Scaleway Clusters API
Where this information came from

This is an independent, third-party profile of Scaleway Database Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.