Read Replicas

id

string

UUID of the Read Replica. (UUID format)

Display Read Replica connection information.

status

Read replica status.

Enum values:

unknown

provisioning

initializing

ready

deleting

error

locked

configuring

Default: unknown

region

string

Region the Read Replica is in.

same_zone

boolean

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

instance_id

string

UUID of the Database Instance.

POST/rdb/v1/regions/{region}/read-replicas

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instance_id":"6170692e-7363-616c-6577-61792e636f6d"}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/read-replicas"

Example Request Body

{
  "instance_id": "6170692e-7363-616c-6577-61792e636f6d",
  "endpoint_spec": [
    {
      "direct_access": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "ipam_config": {}
      }
    }
  ],
  "same_zone": true
}

json

Example Responses

{
  "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"
}

json

application/json

Get a Read Replica

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/read-replicas/{read_replica_id}

Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like endpoints, status and region are returned in the response.

Get a Read Replica › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

read_replica_id

string · required

UUID of the Read Replica. (UUID format)

Get a Read Replica › Responses

200

id

string

UUID of the Read Replica. (UUID format)

Display Read Replica connection information.

status

Read replica status.

Enum values:

unknown

provisioning

initializing

ready

deleting

error

locked

configuring

Default: unknown

region

string

Region the Read Replica is in.

same_zone

boolean

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

instance_id

string

UUID of the Database Instance.

GET/rdb/v1/regions/{region}/read-replicas/{read_replica_id}

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

Example Responses

{
  "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"
}

json

application/json

Delete a Read Replica

DELETE

https://api.scaleway.com

/rdb/v1/regions/{region}/read-replicas/{read_replica_id}

Delete a Read Replica of a Database Instance. You must specify the region and read_replica_id parameters of the Read Replica you want to delete.

Delete a Read Replica › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

read_replica_id

string · required

UUID of the Read Replica. (UUID format)

Delete a Read Replica › Responses

200

id

string

UUID of the Read Replica. (UUID format)

Display Read Replica connection information.

status

Read replica status.

Enum values:

unknown

provisioning

initializing

ready

deleting

error

locked

configuring

Default: unknown

region

string

Region the Read Replica is in.

same_zone

boolean

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

instance_id

string

UUID of the Database Instance.

DELETE/rdb/v1/regions/{region}/read-replicas/{read_replica_id}

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

Example Responses

{
  "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"
}

json

application/json

Create an endpoint for a Read Replica

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/read-replicas/{read_replica_id}/endpoints

Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint.

Create an endpoint for a Read Replica › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

read_replica_id

string · required

UUID of the Read Replica. (UUID format)

Create an endpoint for a Read Replica › Request Body

scaleway.rdb.v1.ReadReplicaEndpointSpec[] · required

Specification of the endpoint you want to create.

Create an endpoint for a Read Replica › Responses

200

id

string

UUID of the Read Replica. (UUID format)

Display Read Replica connection information.

status

scaleway.rdb.v1.UpgradableVersion[]

Read replica status.

Enum values:

unknown

provisioning

initializing

ready

deleting

error

locked

configuring

Default: unknown

region

string

Region the Read Replica is in.

same_zone

boolean

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

instance_id

string

UUID of the Database Instance.

POST/rdb/v1/regions/{region}/read-replicas/{read_replica_id}/endpoints

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"endpoint_spec":[""]}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/read-replicas/{read_replica_id}/endpoints"

Example Request Body

{
  "endpoint_spec": [
    {
      "direct_access": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ip": "1.2.3.4/32",
        "ipam_config": {}
      }
    }
  ]
}

json

Example Responses

{
  "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"
}

json

application/json

Promote a Read Replica

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/read-replicas/{read_replica_id}/promote

Promote a Read Replica to Database Instance automatically.

Promote a Read Replica › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

read_replica_id

string · required

UUID of the Read Replica. (UUID format)

Promote a Read Replica › Request Body

Promote a Read Replica › Responses

200

scaleway.rdb.v1.Instance

created_at

string | null · date-time

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

scaleway.rdb.v1.Volume

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

scaleway.rdb.v1.Instance.Status · enum

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.

scaleway.rdb.v1.InstanceSetting[]

Advanced settings of the Database Instance.

scaleway.rdb.v1.BackupSchedule

Backup schedule of the Database Instance.

is_ha_cluster

boolean

Defines whether or not High-Availability is enabled.

high_availability_mode

scaleway.rdb.v1.HighAvailabilityMode · enum

Defines the High-Availability mode of the instance.

Enum values:

unknown_high_availability_mode

disabled

single_zone

multiple_zone

Default: unknown_high_availability_mode

scaleway.rdb.v1.ReadReplica[]

Read Replicas of the Database Instance.

node_type

string

Node type of the Database Instance.

scaleway.rdb.v1.InstanceSetting[]

List of engine settings to be set at database initialization.

scaleway.rdb.v1.Maintenance[]

List of Database Instance endpoints.

scaleway.rdb.v1.LogsPolicy

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.EncryptionAtRest

Encryption at rest settings for your Database Instance.

POST/rdb/v1/regions/{region}/read-replicas/{read_replica_id}/promote

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

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

Resync a Read Replica

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/read-replicas/{read_replica_id}/reset

When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. The configured endpoints do not change.

Resync a Read Replica › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

read_replica_id

string · required

UUID of the Read Replica. (UUID format)

Resync a Read Replica › Request Body

Resync a Read Replica › Responses

200

id

string

UUID of the Read Replica. (UUID format)

Display Read Replica connection information.

status