rds.instances.getDescribe one database instance
`encryption.storage` is "luks2" (every node's data volume is LUKS2, opened at boot with a per-volume key from KMS) or "none" for a database created before disk encryption; those keep plain volumes and move by restoring into a new database. `encryption.backups` is "aes-256-cbc" (pgBackRest, encrypted on the database machine before upload) or "none" for a database created before backup encryption.
Request syntax
GET /rds/api/instances/{id}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with the database: id, identifier, status, engineVersion, instanceClass, topology, nodeCount, endpointAddress, endpointPort, privateEndpointAddress, allocatedStorageGib, maxAllocatedStorageGib, backupRetentionDays, backupWindow, maintenanceWindow, publiclyAccessible, deletionProtection, tlsRequired, replicationMode, zonePlacement, logicalReplication, masterSecretId, encryption, tags, createdAt, … , plus `placement`: its zones, the zones it survives losing, the leader’s zone and each node’s name, role and zone.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Database id (ewdb-…)orgIdAlwaysstring
Organization that owns the databaseidentifierAlwaysstring
Name of the database, unique within the organizationengineAlwaysone of postgres, docdb
Database engine; postgres for every managed PostgreSQL databaseengineVersionAlwaysstring
PostgreSQL version the database is on, a pinned minor such as 17.11instanceClassAlwaysstring
Instance type of every node, e.g. performance-2regionIdAlwaysstring
Region the database is in, e.g. de1availabilityZoneIdAlwaysstring, may be null
Zone asked for at create (e.g. de1b); null: the region's default zone, or spread over the zones for a clustervpcIdAlwaysstring, may be null
VPC the database joins; null: nonesubnetIdAlwaysstring, may be null
Subnet of that VPC its addresses come from; null: the VPC's whole rangedbNameAlwaysstring, may be null
Database created inside the server at launchmasterUsernameAlwaysstring
Name of the master role, whose password is filed in SecretsallocatedStorageGibAlwaysnumber
Size of each node's data volume, GiBmaxAllocatedStorageGibAlwaysnumber, may be null
Autoscaling ceiling, GiB; null: automatic growth is offstorageTypeAlwaysstring
Storage class label; informationaliopsAlwaysnumber, may be null
Provisioned IOPS; not offered, so nullmultiAzAlwaysboolean
Not used: zonePlacement says how a cluster is spread over zonespubliclyAccessibleAlwaysboolean
Whether the database answers on the internet; false: only from its VPCtopologyAlwaysone of single, cluster
single: one node; cluster: three nodes with automatic failovernodeCountAlwaysnumber
Core nodes: 1 for single, 3 for a cluster (readers not counted)masterSecretIdAlwaysstring, may be null
Secret holding the master password; null until it is filedloadBalancerIdAlwaysstring, may be null
Load balancer in front of a cluster, on the platform's own fleet; null otherwiseendpointKindAlwaysone of hetzner-lb, fleet, may be null
What a cluster's endpoint is: fleet (the platform's own load balancer) or hetzner-lb (the provider's); null on a single nodehetznerLoadBalancerIdAlwaysnumber, may be null
The provider's id of a cluster's load balancer; null when there is nonehetznerNetworkIdAlwaysnumber, may be null
The provider's id of the private network a cluster's members talk over; null on a single nodehetznerFirewallIdAlwaysnumber, may be null
The provider's id of the database's firewall; null before it existsreconcileErrorAlwaysstring, may be null
Why the last provisioning or teardown step failed; null when nothing failedcapacityFallbackAlwaysobject
What the create could fall back to when its type was sold outcapacityFallback.otherZonesAlwaysboolean
A sold-out zone may be replaced by another zone of the regioncapacityFallback.equivalentTypesAlwaysboolean
A sold-out instance type may be replaced by an equivalent oneonStockOutAlwaysone of fail, wait
Sold out with no fallback: fail the create, or wait for stockcapacityWaitUntilAlwaysstring, may be null
While waiting for stock: when the create gives up; null otherwiserequestedInstanceClassAlwaysstring, may be null
The instance type asked for, when a stock fallback bought another; null otherwisestatusAlwaysone of available, creating, modifying, backing-up, deleting, failed, stopped, starting, stopping, rebooting, maintenance, waiting-for-capacity, retained
State of the databaseretainedUntilAlwaysstring, may be null
For a retained database: when its backups are removed; null otherwiseendpointAddressAlwaysstring, may be null
Address clients connect to; null until the database is reachableendpointPortAlwaysnumber, may be null
Direct PostgreSQL port of the endpoint (5432); the pooler is on 6432privateEndpointAddressAlwaysstring, may be null
The database's address inside its VPC, named in its certificate; null: use endpointAddressparameterGroupIdAlwaysstring, may be null
Not used; parameters holds your valuesbackupRetentionDaysAlwaysnumber
Days backups are kept; 0: scheduled backups are offbackupsEnabledAlwaysboolean
Whether scheduled backups are takenstorageEncryptedAlwaysboolean
Whether every node's data volume is encrypted at reststorageKmsKeyIdAlwaysstring, may be null
KMS key that wraps every node volume's key; null: the platform keybackupAgentSeenAtAlwaysstring, may be null
When a node last asked for backup work; null: neverbackupPollerVersionAlwaysnumber, may be null
Version of the backup service on the nodes; 3 and up keep a backup taken by hand until it is deleted; null: not reportedlastBackupAtAlwaysstring, may be null
When the newest backup finished; null: neverbackupWindowAlwaysstring, may be null
When the daily backup runs, UTC HH:MM-HH:MM (only the start is used)maintenanceWindowAlwaysstring, may be null
Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mideletionProtectionAlwaysboolean
While true, delete is refusedperformanceInsightsEnabledAlwaysboolean
Not used; query insights are always onautoMinorVersionUpgradeAlwaysboolean
Whether new minor versions are applied in the maintenance windowparametersAlwaysmap
Your PostgreSQL parameter values by name; parameters not named keep their defaultcaCertIdentifierAlwaysstring, may be null
Name of the CA that signs the server certificatetlsSerialAlwaysstring, may be null
Serial of the server certificate; null: the database has no certificatetlsNotAfterAlwaysstring, may be null
When the server certificate expirestlsNamesInCertAlwaysboolean
Whether the certificate names the database's DNS endpoint namestlsRequiredAlwaysboolean
Whether clients that do not use TLS are refusedreplicationModeAlwaysone of async, sync, may be null
sync: a commit waits for one standby; async: it does not; null on a single nodezonePlacementAlwaysone of spread, single, may be null
spread: members over the zones; single: all in one zone; null on a single nodelogicalReplicationAlwaysboolean
Whether wal_level is logical, for CDC and publicationsbranchPoolOfAlwaysstring, may be null
Set on the machine that serves the branches of another database: that database; null otherwisebranchSettingsAlwaysunknown
Branch settings as stored (branch-settings reads them); null: the defaultslaunchedAtAlwaysstring, may be null
When the database first became availabletagsAlwaysstring, may be null
Kept for compatibility; the tags API holds the tags of the databasecreatedAtAlwaysstring
When the database was createdupdatedAtAlwaysstring
When the database record last changedencryptionAlwaysobject
What is encrypted at restencryption.storageAlwaysone of luks2, none
luks2: every node's data volume is encrypted with a per-volume key from KMS; none: created before disk encryptionencryption.backupsAlwaysone of aes-256-cbc, none
aes-256-cbc: backups are encrypted on the database machine before upload; none: created before backup encryptionplacementAlwaysobject
Where the machines are and what losing a zone doesplacement.zonesAlwaysarray of string
Zones the nodes are inplacement.survivesLossOfAlwaysarray of string
Zones the database keeps serving without (a majority of core nodes is elsewhere)placement.leaderZoneIdAlwaysstring, may be null
Zone of the node that leads now; null when no node is the leaderplacement.nodesAlwaysarray of object
Each node, its role and zoneplacement.nodes[].nameAlwaysstring
Node nameplacement.nodes[].roleAlwaysone of primary, replica
Role as last observedplacement.nodes[].zoneIdAlwaysstring, may be null
Zone of the node
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 instances get idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id" \
-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_get.