Database Instances

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

disable_backup

boolean

Defines whether or not backups are disabled.

tags

string[]

Tags to apply to the Database Instance.

scaleway.rdb.v1.EndpointSpec[]

List of engine settings to be set upon Database Instance initialization.

volume_type

scaleway.rdb.v1.Volume.Type · enum

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

Enum values:

lssd

bssd

sbs_5k

sbs_15k

Default: lssd

volume_size

integer · uint64

Volume size when volume_type is not lssd. (in bytes)

One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created.

backup_same_region

boolean

Defines whether to or not to store logical backups in the same region as the Database Instance.

Encryption at rest settings for your Database Instance.

Create a Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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.

POST/rdb/v1/regions/{region}/instances

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backup_same_region": false,
    "disable_backup": false,
    "engine": "string",
    "is_ha_cluster": false,
    "name": "string",
    "node_type": "string",
    "password": "string",
    "user_name": "string",
    "volume_size": 42
  }' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/instances"

Example Request Body

{
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "engine": "engine",
  "user_name": "user_name",
  "password": "password",
  "node_type": "node_type",
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "disable_backup": true,
  "tags": [
    "string"
  ],
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "volume_type": "lssd",
  "volume_size": 0,
  "init_endpoints": [
    {
      "load_balancer": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "ipam_config": {}
      }
    }
  ],
  "backup_same_region": true,
  "encryption": {
    "enabled": true
  }
}

json

Example Responses

{
  "created_at": "2022-03-22T12:34:56.123456Z",
  "volume": {
    "type": "lssd",
    "size": 0,
    "class": "unknown_storage_class"
  },
  "region": "region",
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "engine": "engine",
  "upgradable_version": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "version": "version",
      "minor_version": "minor_version"
    }
  ],
  "endpoint": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "ip": "1.2.3.4",
    "port": 0,
    "name": "name",
    "private_network": {
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "service_ip": "1.2.3.4/32",
      "zone": "zone",
      "provisioning_mode": "static"
    },
    "load_balancer": {},
    "direct_access": {},
    "hostname": "hostname"
  },
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "backup_schedule": {
    "frequency": 0,
    "retention": 0,
    "disabled": true,
    "next_run_at": "2022-03-22T12:34:56.123456Z"
  },
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "read_replicas": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "ip": "1.2.3.4",
          "port": 0,
          "name": "name",
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
            "service_ip": "1.2.3.4/32",
            "zone": "zone",
            "provisioning_mode": "static"
          },
          "load_balancer": {},
          "direct_access": {},
          "hostname": "hostname"
        }
      ],
      "status": "unknown",
      "region": "region",
      "same_zone": true,
      "instance_id": "instance_id"
    }
  ],
  "node_type": "node_type",
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip": "1.2.3.4",
      "port": 0,
      "name": "name",
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "load_balancer": {},
      "direct_access": {},
      "hostname": "hostname"
    }
  ],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "maintenances": [
    {
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "reason": "reason",
      "status": "unknown",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "is_applicable": true
    }
  ],
  "encryption": {
    "enabled": true
  }
}

json

application/json

Get a Database Instance

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}

Retrieve information about a given Database Instance, specified by the region and instance_id parameters. Its full details, including name, status, IP address and port, are returned in the response object.

Get a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance.

Get a Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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.

GET/rdb/v1/regions/{region}/instances/{instance_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}"

Example Responses

{
  "created_at": "2022-03-22T12:34:56.123456Z",
  "volume": {
    "type": "lssd",
    "size": 0,
    "class": "unknown_storage_class"
  },
  "region": "region",
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "engine": "engine",
  "upgradable_version": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "version": "version",
      "minor_version": "minor_version"
    }
  ],
  "endpoint": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "ip": "1.2.3.4",
    "port": 0,
    "name": "name",
    "private_network": {
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "service_ip": "1.2.3.4/32",
      "zone": "zone",
      "provisioning_mode": "static"
    },
    "load_balancer": {},
    "direct_access": {},
    "hostname": "hostname"
  },
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "backup_schedule": {
    "frequency": 0,
    "retention": 0,
    "disabled": true,
    "next_run_at": "2022-03-22T12:34:56.123456Z"
  },
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "read_replicas": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "ip": "1.2.3.4",
          "port": 0,
          "name": "name",
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
            "service_ip": "1.2.3.4/32",
            "zone": "zone",
            "provisioning_mode": "static"
          },
          "load_balancer": {},
          "direct_access": {},
          "hostname": "hostname"
        }
      ],
      "status": "unknown",
      "region": "region",
      "same_zone": true,
      "instance_id": "instance_id"
    }
  ],
  "node_type": "node_type",
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip": "1.2.3.4",
      "port": 0,
      "name": "name",
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "load_balancer": {},
      "direct_access": {},
      "hostname": "hostname"
    }
  ],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "maintenances": [
    {
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "reason": "reason",
      "status": "unknown",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "is_applicable": true
    }
  ],
  "encryption": {
    "enabled": true
  }
}

json

application/json

Delete a Database Instance

DELETE

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}

Delete a given Database Instance, specified by the region and instance_id parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

Delete a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance to delete.

Delete a Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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.

DELETE/rdb/v1/regions/{region}/instances/{instance_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}"

Example Responses

{
  "created_at": "2022-03-22T12:34:56.123456Z",
  "volume": {
    "type": "lssd",
    "size": 0,
    "class": "unknown_storage_class"
  },
  "region": "region",
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "engine": "engine",
  "upgradable_version": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "version": "version",
      "minor_version": "minor_version"
    }
  ],
  "endpoint": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "ip": "1.2.3.4",
    "port": 0,
    "name": "name",
    "private_network": {
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "service_ip": "1.2.3.4/32",
      "zone": "zone",
      "provisioning_mode": "static"
    },
    "load_balancer": {},
    "direct_access": {},
    "hostname": "hostname"
  },
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "backup_schedule": {
    "frequency": 0,
    "retention": 0,
    "disabled": true,
    "next_run_at": "2022-03-22T12:34:56.123456Z"
  },
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "read_replicas": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "ip": "1.2.3.4",
          "port": 0,
          "name": "name",
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
            "service_ip": "1.2.3.4/32",
            "zone": "zone",
            "provisioning_mode": "static"
          },
          "load_balancer": {},
          "direct_access": {},
          "hostname": "hostname"
        }
      ],
      "status": "unknown",
      "region": "region",
      "same_zone": true,
      "instance_id": "instance_id"
    }
  ],
  "node_type": "node_type",
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip": "1.2.3.4",
      "port": 0,
      "name": "name",
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "load_balancer": {},
      "direct_access": {},
      "hostname": "hostname"
    }
  ],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "maintenances": [
    {
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "reason": "reason",
      "status": "unknown",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "is_applicable": true
    }
  ],
  "encryption": {
    "enabled": true
  }
}

json

application/json

Update a Database Instance

PATCH

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}

Update the parameters of a Database Instance, including name, tags and backup schedule details.

Update a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance to update.

Update a Database Instance › Request Body

backup_schedule_frequency

integer | null · uint32

In hours.

backup_schedule_retention

integer | null · uint32

In days.

is_backup_schedule_disabled

boolean | null

Defines whether or not the backup schedule is disabled.

name

string | null

Name of the Database Instance.

tags

array | null

Tags of a Database Instance.

Logs policy of the Database Instance.

backup_same_region

boolean | null

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

backup_schedule_start_hour

integer | null · uint32

Defines the start time of the autobackup.

Update a Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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

List of Database Instance maintenance events.

scaleway.rdb.v1.Maintenance

Encryption at rest settings for your Database Instance.

PATCH/rdb/v1/regions/{region}/instances/{instance_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}"

Example Request Body

{
  "backup_schedule_frequency": 0,
  "backup_schedule_retention": 0,
  "is_backup_schedule_disabled": true,
  "name": "name",
  "tags": [],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "backup_schedule_start_hour": 0
}

json

Example Responses

{
  "created_at": "2022-03-22T12:34:56.123456Z",
  "volume": {
    "type": "lssd",
    "size": 0,
    "class": "unknown_storage_class"
  },
  "region": "region",
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "engine": "engine",
  "upgradable_version": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "version": "version",
      "minor_version": "minor_version"
    }
  ],
  "endpoint": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "ip": "1.2.3.4",
    "port": 0,
    "name": "name",
    "private_network": {
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "service_ip": "1.2.3.4/32",
      "zone": "zone",
      "provisioning_mode": "static"
    },
    "load_balancer": {},
    "direct_access": {},
    "hostname": "hostname"
  },
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "backup_schedule": {
    "frequency": 0,
    "retention": 0,
    "disabled": true,
    "next_run_at": "2022-03-22T12:34:56.123456Z"
  },
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "read_replicas": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "ip": "1.2.3.4",
          "port": 0,
          "name": "name",
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
            "service_ip": "1.2.3.4/32",
            "zone": "zone",
            "provisioning_mode": "static"
          },
          "load_balancer": {},
          "direct_access": {},
          "hostname": "hostname"
        }
      ],
      "status": "unknown",
      "region": "region",
      "same_zone": true,
      "instance_id": "instance_id"
    }
  ],
  "node_type": "node_type",
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip": "1.2.3.4",
      "port": 0,
      "name": "name",
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "load_balancer": {},
      "direct_access": {},
      "hostname": "hostname"
    }
  ],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "maintenances": [
    {
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "reason": "reason",
      "status": "unknown",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "is_applicable": true
    }
  ],
  "encryption": {
    "enabled": true
  }
}

json

application/json

Apply Database Instance maintenance

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/apply-maintenance

Apply maintenance tasks to your Database Instance. This will trigger pending maintenance tasks to start in your Database Instance and can generate service interruption. Maintenance tasks can be applied between starts_at and stops_at times, and are run directly by Scaleway at forced_at timestamp.

Apply Database Instance maintenance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want to apply maintenance.

Apply Database Instance maintenance › Request Body

Apply Database Instance maintenance › Responses

200

starts_at

string | null · date-time

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

stops_at

string | null · date-time

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

closed_at

string | null · date-time

Closed maintenance date. (RFC 3339 format)

reason

string

Maintenance information message.

status

scaleway.rdb.v1.Maintenance.Status · enum

Status of the maintenance.

Enum values:

unknown

pending

done

canceled

ongoing

Default: unknown

forced_at

string | null · date-time

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

is_applicable

boolean

Indicate if the maintenance can be applied by the user.

Get the TLS certificate of a Database Instance

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/certificate

Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response.

Get the TLS certificate of a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance.

Get the TLS certificate of a Database Instance › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Clone a Database Instance

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/clone

Clone a given Database Instance, specified by the region and instance_id parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one.

Clone a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want to clone.

Clone a Database Instance › Request Body

name

string

Name of the Database Instance clone.

node_type

string | null

Node type of the clone.

Clone a Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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

List of Database Instance maintenance events.

scaleway.rdb.v1.ListInstanceLogsResponse

Encryption at rest settings for your Database Instance.

POST/rdb/v1/regions/{region}/instances/{instance_id}/clone

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/clone"

Example Request Body

{
  "name": "name",
  "node_type": "node_type"
}

json

Example Responses

{
  "created_at": "2022-03-22T12:34:56.123456Z",
  "volume": {
    "type": "lssd",
    "size": 0,
    "class": "unknown_storage_class"
  },
  "region": "region",
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "engine": "engine",
  "upgradable_version": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "version": "version",
      "minor_version": "minor_version"
    }
  ],
  "endpoint": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "ip": "1.2.3.4",
    "port": 0,
    "name": "name",
    "private_network": {
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "service_ip": "1.2.3.4/32",
      "zone": "zone",
      "provisioning_mode": "static"
    },
    "load_balancer": {},
    "direct_access": {},
    "hostname": "hostname"
  },
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "backup_schedule": {
    "frequency": 0,
    "retention": 0,
    "disabled": true,
    "next_run_at": "2022-03-22T12:34:56.123456Z"
  },
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "read_replicas": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "ip": "1.2.3.4",
          "port": 0,
          "name": "name",
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
            "service_ip": "1.2.3.4/32",
            "zone": "zone",
            "provisioning_mode": "static"
          },
          "load_balancer": {},
          "direct_access": {},
          "hostname": "hostname"
        }
      ],
      "status": "unknown",
      "region": "region",
      "same_zone": true,
      "instance_id": "instance_id"
    }
  ],
  "node_type": "node_type",
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip": "1.2.3.4",
      "port": 0,
      "name": "name",
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "load_balancer": {},
      "direct_access": {},
      "hostname": "hostname"
    }
  ],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "maintenances": [
    {
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "reason": "reason",
      "status": "unknown",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "is_applicable": true
    }
  ],
  "encryption": {
    "enabled": true
  }
}

json

application/json

List available logs of a Database Instance

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/logs

List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List available logs of a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want logs of.

List available logs of a Database Instance › query Parameters

order_by

scaleway.rdb.v1.ListInstanceLogsRequest.OrderBy · enum

Criteria to use when ordering Database Instance logs listing.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

List available logs of a Database Instance › Responses

200

scaleway.rdb.v1.InstanceLog[]

Available logs in a Database Instance.

List remote Database Instance logs details

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/logs-details

List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List remote Database Instance logs details › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want logs of.

List remote Database Instance logs details › Responses

200

scaleway.rdb.v1.ListInstanceLogsDetailsResponse

scaleway.rdb.v1.ListInstanceLogsDetailsResponse.InstanceLogDetail[]

Remote Database Instance logs details.

deprecated

[deprecated] Get Database Instance metrics

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/metrics

Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the start_date and end_date. This method is deprecated and will be removed in a future version.

[deprecated] Get Database Instance metrics › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance.

[deprecated] Get Database Instance metrics › query Parameters

start_date

string · date-time

Start date to gather metrics from. (RFC 3339 format)

end_date

string · date-time

End date to gather metrics from. (RFC 3339 format)

metric_name

string

Name of the metric to gather.

[deprecated] Get Database Instance metrics › Responses

200

scaleway.rdb.v1.InstanceMetrics

scaleway.std.TimeSeries[]

Time series of metrics of a Database Instance.

Prepare logs of a Database Instance

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/prepare-logs

Prepare your Database Instance logs. You can define the start_date and end_date parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a .log file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours.

Prepare logs of a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want logs of.

Prepare logs of a Database Instance › Request Body

start_date

string | null · date-time

Start datetime of your log. (RFC 3339 format). (RFC 3339 format)

end_date

string | null · date-time

End datetime of your log. (RFC 3339 format). (RFC 3339 format)

Prepare logs of a Database Instance › Responses

200

scaleway.rdb.v1.PrepareInstanceLogsResponse

scaleway.rdb.v1.InstanceLog[]

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

Purge remote Database Instance logs

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/purge-logs

Purge a given remote log from a Database Instance. You can specify the log_name of the log you wish to clean from your Database Instance.

Purge remote Database Instance logs › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want logs of.

Purge remote Database Instance logs › Request Body

log_name

string | null

Given log name to purge.

Purge remote Database Instance logs › Responses

No data returned

Renew the TLS certificate of a Database Instance

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/renew-certificate

Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.

Renew the TLS certificate of a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want logs of.

Renew the TLS certificate of a Database Instance › Request Body

Renew the TLS certificate of a Database Instance › Responses

No data returned

Restart Database Instance

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/restart

Restart a given Database Instance, specified by the region and instance_id parameters. The status of the Database Instance returned in the response.

Restart Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want to restart.

Restart Database Instance › Request Body

Restart Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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.

POST/rdb/v1/regions/{region}/instances/{instance_id}/restart

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/restart"

Example Request Body

{}

json

Example Responses

{
  "created_at": "2022-03-22T12:34:56.123456Z",
  "volume": {
    "type": "lssd",
    "size": 0,
    "class": "unknown_storage_class"
  },
  "region": "region",
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "engine": "engine",
  "upgradable_version": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "version": "version",
      "minor_version": "minor_version"
    }
  ],
  "endpoint": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "ip": "1.2.3.4",
    "port": 0,
    "name": "name",
    "private_network": {
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "service_ip": "1.2.3.4/32",
      "zone": "zone",
      "provisioning_mode": "static"
    },
    "load_balancer": {},
    "direct_access": {},
    "hostname": "hostname"
  },
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "backup_schedule": {
    "frequency": 0,
    "retention": 0,
    "disabled": true,
    "next_run_at": "2022-03-22T12:34:56.123456Z"
  },
  "is_ha_cluster": true,
  "high_availability_mode": "unknown_high_availability_mode",
  "read_replicas": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "ip": "1.2.3.4",
          "port": 0,
          "name": "name",
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
            "service_ip": "1.2.3.4/32",
            "zone": "zone",
            "provisioning_mode": "static"
          },
          "load_balancer": {},
          "direct_access": {},
          "hostname": "hostname"
        }
      ],
      "status": "unknown",
      "region": "region",
      "same_zone": true,
      "instance_id": "instance_id"
    }
  ],
  "node_type": "node_type",
  "init_settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip": "1.2.3.4",
      "port": 0,
      "name": "name",
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "load_balancer": {},
      "direct_access": {},
      "hostname": "hostname"
    }
  ],
  "logs_policy": {
    "max_age_retention": 0,
    "total_disk_retention": 0
  },
  "backup_same_region": true,
  "maintenances": [
    {
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "reason": "reason",
      "status": "unknown",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "is_applicable": true
    }
  ],
  "encryption": {
    "enabled": true
  }
}

json

application/json

Upgrade a Database Instance

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/instances/{instance_id}/upgrade

Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the enable_ha parameter can only be set to true.

Upgrade a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

instance_id

string · required

UUID of the Database Instance you want to upgrade.

Upgrade a Database Instance › Request Body

node_type

string | null

Node type of the Database Instance you want to upgrade to.

Defines the High-Availability mode of the instance.

volume_size

integer | null · uint64

Increase your block storage volume size.

Change your Database Instance storage type.

upgradable_version_id

string | null

Update your database engine to a newer version. This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade. (UUID format)

Upgrade your database engine to a new major version including instance endpoints.

enable_encryption

boolean | null

Defines whether or not encryption should be enabled on the Database Instance.

Upgrade a Database Instance › Responses

200

created_at

string | null · date-time

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

Volumes of the Database Instance.

region

string

Region the Database Instance is in.

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

organization_id

string

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

project_id

string

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

status

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

engine

string

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

Available database engine versions for upgrade.

tags

string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

Read Replicas of the Database Instance.

node_type

string

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.

backup_same_region

boolean

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

List of Database Instance maintenance events.