---
title: "Update Db Connection"
method: PUT
path: "/api/database-connections/{id}"
tags: ["Database Connection"]
---

# Update Db Connection

`PUT /api/database-connections/{id}`

## Path parameters

- `id` string, required

## Request body

- DBConnectionRequest
  - `alias` string, required
  - `use_ssh` boolean
  - `connection_uri` string, required
  - `ssh_settings` SSHSettings
    - `host` string
    - `username` string
    - `password` string
  - `metadata` object
  - `bigquery_credential_file_content` union
    - object
    - string
  - `sqlite_file_path` string

## Response `200`

Successful Response

- DBConnectionResponse
  - `alias` string, required
  - `use_ssh` boolean
  - `connection_uri` string, required
  - `ssh_settings` InternalSSHSettings
    - `host` string
    - `username` string
    - `password` string
    - `private_key_password` string
  - `metadata` DBConnectionMetadata
    - `dh_internal` DHDBConnectionMetadata
      - `organization_id` string
  - `id` string
  - `created_at` string, date-time
  - `path_to_credentials_file` string

## Other responses

- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/dataherald/apis/fastapi.md) · [All operations](https://skmtc.dev/dataherald/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dataherald/fastapi/revisions/e168e98625a8/schema)