Skip to content
Authrim

Update database connection

PATCH
/api/admin/database-connections/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/database-connections/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "Tenant PII PostgreSQL", "description": "Primary tenant PII database.", "config": { "host": "db.example.com", "port": 5432, "database": "authrim_pii", "ssl": true }, "status": "active" }'

Updates display name, description, config, or active/disabled status for an admin-managed database connection.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Database connection ID.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
display_name
string
description
One of:
string
config
object
key
additional properties
status
string
Allowed values: active disabled
key
additional properties
Example 
{
  "display_name": "Tenant PII PostgreSQL",
  "description": "Primary tenant PII database.",
  "config": {
    "host": "db.example.com",
    "port": 5432,
    "database": "authrim_pii",
    "ssl": true
  },
  "status": "active"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Database connection.

Media type application/json
object
id
string
name
string
display_name
string
description
One of:
string
provider
string
Allowed values: d1 hyperdrive postgres mysql custom
config
object
key
additional properties
managed_by
string
read_only
boolean
has_credential
boolean
credential_key_version
One of:
integer
credential_updated_at
One of:
integer
credential_updated_by
One of:
string
status
string
Allowed values: active disabled
created_by
One of:
string
updated_by
One of:
string
created_at
integer
updated_at
integer
tenant_assignments
Array<object>
object
id
required
string
name
required
string
kind
required
string
Allowed values: tenant platform
key
additional properties
key
additional properties
Example 
{
  "id": "dbc_123",
  "name": "tenant-pii-postgres",
  "display_name": "Tenant PII PostgreSQL",
  "description": "External PostgreSQL database for tenant PII workloads.",
  "provider": "postgres",
  "config": {
    "host": "db.example.com",
    "port": 5432,
    "database": "authrim_pii",
    "ssl": true
  },
  "managed_by": "admin",
  "read_only": false,
  "has_credential": true,
  "credential_key_version": 1,
  "credential_updated_at": 1770000000000,
  "credential_updated_by": "admin_123",
  "status": "active",
  "created_by": "admin_123",
  "updated_by": "admin_123",
  "created_at": 1770000000000,
  "updated_at": 1770000000000,
  "tenant_assignments": [
    {
      "id": "tenant_123",
      "name": "Tenant",
      "kind": "tenant"
    }
  ]
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}