rds.tls.getThe TLS requirement and certificate; with clients=true, every client connected without TLS on either port
Request syntax
GET /rds/api/instances/{id}/tlsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Query parameters
clientsOptionalenum
Also list the clients connected without TLS right now
One of:
true,falseDefault:
"false"
Response
200 with required, certificate ({ serial, notAfter } or null), plaintextClients (null unless clients=true), unaskedNodes and plaintextError.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
requiredAlwaysboolean
Whether clients that do not use TLS are refusedcertificateAlwaysobject, may be null
The server certificate; null: the database has nonecertificate.serialAlwaysstring
Serial of the server certificatecertificate.notAfterAlwaysstring, may be null
When it expiresplaintextClientsAlwaysarray of object, may be null
Clients connected without TLS now; null unless clients=true was askedplaintextClients[].nodeAlwaysstring
Node the client is connected toplaintextClients[].portAlwaysnumber
5432 (direct) or 6432 (pooler)plaintextClients[].userAlwaysstring
RoleplaintextClients[].databaseAlwaysstring, may be null
DatabaseplaintextClients[].applicationAlwaysstring, may be null
application_name the client setplaintextClients[].addressAlwaysstring
Client addressplaintextClients[].connectionsAlwaysnumber
Connections from itunaskedNodesAlwaysarray of string
Nodes that could not be asked for their clientsplaintextErrorAlwaysstring, may be null
Why the clients could not be listed; null otherwise
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:DescribeDBInstances 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 get idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/tls" \
-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_tls_get.