rds.tls.setRequire TLS (hostssl, PgBouncer require) or stop requiring it, on every node; verified by a plaintext probe
Open sessions are not cut: pg_hba and the pooler are consulted when a connection starts, so a plaintext client breaks at its next reconnect.
Request syntax
PATCH /rds/api/instances/{id}/tls
{
"required": "boolean"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Request body
requiredRequiredboolean
true: refuse plaintext clients on ports 5432 and 6432; false: accept them again. Open sessions are not cut
Response
200 with required, verified (true when every node’s probe confirms it), changed, cluster, nodes (per-node outcome) and probes (per node, ports 5432 and 6432).
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
requiredAlwaysboolean
The setting now storedverifiedAlwaysboolean
Every node applied it and a plaintext probe confirmed it on both portschangedAlwaysboolean
A configuration was rewritten by this callclusterAlwaysone of already, updated, unreachable, failed, may be null
The cluster's shared client rules: already, updated, unreachable or failed; null on a single nodenodesAlwaysarray of object
Outcome per nodenodes[].nodeAlwaysstring
Node namenodes[].outcomeAlwaysone of already, updated, unreachable, failed
already (nothing to change), updated, unreachable (retried later) or failedprobesAlwaysarray of object
Plaintext probe of each running nodeprobes[].nodeAlwaysstring
Node nameprobes[].directAlwaysone of refused, accepted, unreachable
A plaintext connection to 5432: refused, accepted or unreachableprobes[].pooledAlwaysone of refused, accepted, unreachable
A plaintext connection to 6432: refused, accepted or unreachable
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:ModifyDBInstance 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 tls set id --requiredcurl -X PATCH "https://console.platform-development.deutschecloud.app/rds/api/instances/id/tls" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"required":true}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_tls_set.