Skip to content

docs: add missing Database fields to Developer API schema #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
enesgules merged 3 commits into from
Oct 22, 2026
Merged

docs: add missing Database fields to Developer API schema #920

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c36a478
docs: add missing Database fields to Developer API schema
context7[bot] Oct 14, 2026
d99a035
docs: correct the new Database fields
enesgules Oct 22, 2026
c093976
docs: credential protection also hides the database credentials
enesgules Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion devops/developer-api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,6 +1745,10 @@ components:
type: string
description: Name of the database
example: MyRedis
database_type:
type: string
description: Pricing model of the database, one of `free`, `Pay as You Go` or `Enterprise`
example: Pay as You Go
region:
type: string
description: The region where database is hosted
Expand Down Expand Up @@ -1772,10 +1776,23 @@ components:
type: string
description: Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)
example: beloved-stallion-58500
rest_token:
type: string
description: REST token for the database. Omitted when credential protection is on, when you pass the `credentials=hide` query parameter to Get Database, or when the API key or your team role is read-only.
read_only_rest_token:
type: string
description: Read-only REST token for the database. Omitted when credential protection is on, or when you pass the `credentials=hide` query parameter to Get Database.
password:
type: string
description: Password of the database. Omitted when credential protection is on, when you pass the `credentials=hide` query parameter to Get Database, or when the API key or your team role is read-only.
tls:
type: boolean
description: TLS/SSL is enabled or not
example: true
db_daily_bandwidth_limit:
type: integer
description: Daily bandwidth limit for the database (in bytes). The response can omit this field.
format: int64
db_max_clients:
type: integer
description: Max number of concurrent clients can be opened on this database currently
Expand Down Expand Up @@ -1930,7 +1947,7 @@ components:
type: integer
description: Replica factor of the database
example: 5
customer_id:
user_email:
type: string
description: Owner identifier of the database (may be email or marketplace-scoped email)
example: "example@upstash.com"
Expand Down
Loading