Schemas

(IP network)

(IP network)

ACL Rules enabled for the Database Instance.

Settings available on the Database Instance.

Name of the database.

Name of the database owner.

Defines whether the database is managed or not.

Size of the database. Set to 0 if the size retrieval is too time-consuming or skip_size_retrieval is set to true. (in bytes)

UUID of the database backup.

UUID of the Database Instance.

Name of backed up database.

Name of the backup.

Status of the backup.

Size of the database backup. (in bytes)

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

Name of the Database Instance of the backup.

URL you can download the backup from.

Expiration date of the download link. (RFC 3339 format)

Region of the database backup.

Store logical backups in the same region as the source Database Instance.

Engine name.

Engine logo URL.

Available versions.

Region of this Database Instance.

IP addresses defined in the ACL rules of the Database Instance.

Settings names to delete from the Database Instance.

UUID of the endpoint. (UUID format)

IPv4 address of the endpoint. (IP address)

TCP port of the endpoint.

Name of the endpoint.

Private Network details. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).

Load balancer details. Public endpoint for Database Instance which is systematically present. One per Database Instance.

Direct access details. Public endpoint reserved for Read Replicas. One per Read Replica.

Hostname of the endpoint.

Load balancer endpoint specifications. Public endpoint for Database Instance which is systematically present. One per RDB instance.

Private Network endpoint specifications. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).

Setting name from the database engine.

Value set when not specified.

Setting can be applied without restarting.

Setting description.

Setting type.

Setting base unit.

Validation regex for string type settings.

Minimum value for int types.

Maximum value for int types.

Minimum value for float types.

Maximum value for float types.

Database engine version.

Database engine name.

End of life date. (RFC 3339 format)

Engine settings available to be set.

Disabled versions cannot be created.

Beta status of engine version.

Engine settings available to be set at database initialization.

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

Volumes of the Database Instance.

Region the Database Instance is in.

UUID of the Database Instance. (UUID format)

Name of the Database Instance.

Organization ID the Database Instance belongs to. (UUID format)

Project ID the Database Instance belongs to. (UUID format)

Status of the Database Instance.

Database engine of the database (PostgreSQL, MySQL, ...).

Available database engine versions for upgrade.

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

Defines whether or not High-Availability is enabled.

Read Replicas of the Database Instance.

Node type of the Database Instance.

List of engine settings to be set at database initialization.

List of Database Instance endpoints.

Logs policy of the Database Instance.

Store logical backups in the same region as the Database Instance.

List of Database Instance maintenance events.

Encryption at rest settings for your Database Instance.

Presigned Object Storage URL to download your log file.

UUID of the Database Instance log.

Status of the logs in a Database Instance.

Name of the underlying node.

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

Region the Database Instance is in.

Time series of metrics of a Database Instance.

List of database backups.

Total count of database backups available.

List of the available database engines.

Total count of database engines available.

List of the databases.

Total count of databases present on a Database Instance.

List of ACL rules present on a Database Instance.

Total count of ACL rules present on a Database Instance.

Remote Database Instance logs details.

Available logs in a Database Instance.

List of all Database Instances available in an Organization or Project.

Total count of Database Instances available in a Organization or Project.

Types of the node.

Total count of node-types available.

Privileges of a user in a database in a Database Instance.

Total count of privileges present on a database.

List of snapshots.

Total count of snapshots available.

List of users in a Database Instance.

Total count of users present on a Database Instance.

Start date of the maintenance window. (RFC 3339 format)

End date of the maintenance window. (RFC 3339 format)

Closed maintenance date. (RFC 3339 format)

Maintenance information message.

Status of the maintenance.

Time when Scaleway-side maintenance will be applied. (RFC 3339 format)

Indicate if the maintenance can be applied by the user.

Node Type name identifier.

Current stock status for the Node Type.

Current specs of the offer.

Number of virtual CPUs.

Quantity of RAM. (in bytes)

The Node Type is currently disabled.

The Node Type is currently in beta.

Available storage options for the Node Type.

The Node Type can be used only with high availability option.

Generation associated with the NodeType offer.

Instance range associated with the NodeType offer.

Region the Node Type is in.

Volume Type.

The description of the Volume.

Minimum size required for the Volume. (in bytes)

Maximum size required for the Volume. (in bytes)

Minimum increment level for a Block Storage volume size. (in bytes)

The storage class of the volume.

Instance logs for a Database Instance between a start and an end date.

Permission (Read, Read/Write, All, Custom).

Name of the database.

Name of the user.

UUID of the Read Replica. (UUID format)

Display Read Replica connection information.

Read replica status.

Region the Read Replica is in.

Whether the replica is in the same availability zone as the main instance nodes or not.

UUID of the Database Instance.

Direct access endpoint specifications. Public endpoint reserved for Read Replicas. One per Read Replica.

Private Network endpoint specifications. One at the most per Read Replica. Cannot be updated (has to be deleted and recreated).

ACLs rules configured for a Database Instance.

Settings configured for a Database Instance.

UUID of the snapshot.

UUID of the Database Instance.

Name of the snapshot.

Status of the snapshot.

Size of the snapshot. (in bytes)

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

Name of the Database Instance of the snapshot.

Source node type.

Type of volume where data is stored (lssd, bssd or sbs).

Region of this snapshot.

(UUID format)

Name of the user (Length must be between 1 and 63 characters for PostgreSQL and between 1 and 32 characters for MySQL. First character must be an alphabet character (a-zA-Z). Your username cannot start with 'rdb' or in PostgreSQL, 'pg'. Only a-zA-Z0-9_$- characters are accepted).

Defines whether or not a user got administrative privileges on the Database Instance.