rds.instances.add-readerAdd a read replica to a cluster; it serves on the reader endpoint (5433, 6433) once streaming
Request syntax
POST /rds/api/instances/{id}/readersPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
202 with the new node, as `list-nodes` shows it: id, name, ordinal, role, status, … ; its machine is built in the background.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Node iddbInstanceIdAlwaysstring
Database the node belongs toorgIdAlwaysstring
Organization that owns the databaseordinalAlwaysnumber
1-based position; 1 to 3 are the core members, higher ones readersnameAlwaysstring
Machine nameroleAlwaysone of primary, replica
Role as last observed: primary leadsstatusAlwaysone of provisioning, bootstrapping, running, stopped, failed, deleting
State of the machinehetznerServerIdAlwaysnumber, may be null
The provider's id of the machine; null before it is boughthetznerVolumeIdAlwaysnumber, may be null
The provider's id of the data volume; null before it is createdavailabilityZoneIdAlwaysstring, may be null
Zone of the machine and its volume; null: the region's default zonediskUsedPercentAlwaysnumber, may be null
Data volume usage as last reported, percent; null: not reportedprivateIpv4Alwaysstring, may be null
Address on the cluster's private networkpublicIpv4Alwaysstring, may be null
Public address of the machinevpcIpv4Alwaysstring, may be null
Address in the database's VPC; null: nonelastSeenAtAlwaysstring, may be null
When the node last reportedengineVersionAlwaysstring, may be null
PostgreSQL version the server reports, e.g. 17.11; null until it answersengineVersionReportedAtAlwaysstring, may be null
When engineVersion was readmaintenanceAgentSeenAtAlwaysstring, may be null
When the node last asked for maintenance work; null: it cannot be upgraded in placeinstalledPackageVersionAlwaysstring, may be null
PostgreSQL package installed on the nodemaintenanceOperationAlwaysunknown
The current or last in-place maintenance operation of the node; null: nonepoolerRebootSafeAtAlwaysstring, may be null
When the connection pooler was last confirmed to come back after a rebootcreatedAtAlwaysstring
When the node was createdupdatedAtAlwaysstring
When the node record last changed
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow rds:CreateDBReadReplica on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud rds instances add-reader idcurl -X POST "https://console.platform-development.deutschecloud.app/rds/api/instances/id/readers" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_instances_add-reader.