errors.databases.connect

Connect a PostgreSQL database of the organization to the project

PUT /errors/api/projects/{id}/databases/{dbInstanceId}IAM errors:UpdateProjectChanges state

Needs errors:UpdateProject on the project AND rds:DescribeDBQueryInsights on the database. The audit entry of the project names the database; a refusal on either is recorded. Connecting grants nobody anything: each reader still needs rds:DescribeDBQueryInsights to see its statements. At most 10 databases per project.

Depending on the resource, the call checks rds:DescribeDBQueryInsights instead; hold all of them to be sure it is allowed.

Request syntax

PUT /errors/api/projects/{id}/databases/{dbInstanceId}

Path parameters

  • idRequired

    string

    Constraints: uuid

  • dbInstanceIdRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

Response

201 with { dbInstanceId, identifier, projectId, connected: true }; 200 with the same when it was already connected. 404 when the project does not exist or the id is not a database id (a Document Database cluster’s ewdoc-… id included), 404 "Database not found" when the database is not one of your organization’s; 400 TooManyDatabases when the project already has 10 (also for one of those 10); 403 without either permission.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

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 errors:UpdateProject 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 errors databases connect id dbInstanceId

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_errors_databases_connect.