rds.instances.set-public-accessTurn public access on or off; the firewall changes at once, the address stays
Single-node databases only (a cluster answers 409). Clients inside the VPC keep working either way. Turning it off closes the client ports to the internet; the platform keeps its own access for backups and the console.
Request syntax
PATCH /rds/api/instances/{id}/public-access
{
"publiclyAccessible": "boolean"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Request body
publiclyAccessibleRequiredboolean
true: the database answers on the internet; false: only its network and the platform
Response
200 with { publiclyAccessible }, the setting now in force.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
publiclyAccessibleAlwaysboolean
Whether the database answers on the internet now
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 instances set-public-access id --publicly-accessiblecurl -X PATCH "https://console.platform.deutschecloud.app/rds/api/instances/id/public-access" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"publiclyAccessible":true}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_instances_set-public-access.