Rotate database credentials API Reference

POST

/tenants/{tenant}/databases/{name}/rotate-credentials

curl --request POST \
  --url https://api.kupe.cloud/api/v1/tenants/acme/databases/orders-db/rotate-credentials \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "role": "owner" }'

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

name

required

string

Database name

Request Body

Role to rotate

Media type application/json

object

role

Role whose password is rotated: owner (app_owner), readwrite (app_readwrite) or readonly (app_readonly).

string

Allowed values: owner readwrite readonly

Example

readwrite

Responses

202

Rotation requested

Media type application/json

object

database

string

requestedAt

string

role

string

Allowed values: owner readwrite readonly

Example

{
  "database": "orders-db",
  "requestedAt": "2026-10-09T12:00:00.123456789Z",
  "role": "owner"
}

400

Validation error

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Admin access required

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Database not found, or databases are not enabled (code databases_unavailable)

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

409

Database is being deleted (code terminating)

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}