Skip to content
Console
On this page

Update a database

Updates a database.

Updates a database. Fields declared by the current Release's sylphx.toml remain manifest-owned. An overlapping update mask returns HTTP 409 with FAILED_PRECONDITION, the file and key path, and the Release's source commit. Change and release the declaration instead. Undeclared fields remain writable; releasing a manifest without a field restores API writes to that field.

  • Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database
  • Scope data:write
  • Effect write — a successful call changes state.
  • Collection databases
  • Query update_mask, allow_missing, validate_only
  • Operation answers with an Operation; the result is Database

Request

FieldTypeWhat it is
databaseDatabaseThe database to update; name identifies it. Required.
update_maskfield_maskThe fields to write; unset writes every populated field.
allow_missingboolCreate the Resource when it does not exist (declarative upsert).
validate_onlyboolValidate and return the result without writing anything.

Database

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/databases/{database}.
metaResourceMetaResource metadata.
specDatabaseSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

DatabaseSpec

FieldTypeWhat it is
postgres_versionstringThe Postgres major version, for example 17; default the newest supported.
compute_unitsdoubleCompute size in units; default the plan's. max_connections derives from it.
regionstringThe region; default the project's home region. Changing it moves the data by signed export and import.
deletion_protectionboolWhile set, Delete fails with DELETION_PROTECTED.
client_allowliststring[]Address ranges allowed to connect to the database's endpoint. An entry is an IPv4 or IPv6 range like 203.0.113.0/24 or 2001:db8::/32, at most 50, applied on both the pooled and the direct host a connection can reach. A connection from any other address is refused at the endpoint with the database's own answer (SQLSTATE 28000), before it reaches Postgres; a connection from a listed address is served as usual. Empty serves every address (the field absent), so clearing it re-opens the endpoint. Send client_allowlist_set to store an empty list.
client_allowlist_setboolStores client_allowlist as given, including an empty list that re-opens the endpoint. An empty repeated field is not a change on its own, so Update sends client_allowlist_set (or clientAllowlistSet) as true when it means to clear the list; any non-empty client_allowlist is stored whether or not this is set. Reads always report false.

Response

FieldTypeWhat it is
namestring{parent-of-target}/operations/{operation}.
targetstringThe name of the Resource being changed.
target_generationint64The generation this Operation waits for.
verbOperationVerbWhat the Operation does. One of create, update, delete, custom.
custom_verbstringThe custom method verb when verb is CUSTOM, for example revoke.
doneboolWhether the Operation has finished.
create_timetimestampWhen the Operation started.
end_timetimestampWhen the Operation finished.
responseanyThe settled Resource (or Empty for a delete). One of the result group.
errorProblemDetailsThe failure, as the one error body. One of the result group.
progressOperationProgressProgress while not done.

ProblemDetails

FieldTypeWhat it is
typestringhttps://sylphx.com/docs/errors/<code in kebab-case>.
titlestringA short customer-safe summary of the problem class.
statusint32The HTTP status, fixed by grpc_status.
detailstringA customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data.
instancestringThe request id (Sylphx-Request-Id).
codestringThe stable UPPER_SNAKE code, one of ErrorCode without its prefix.
grpc_statusstringOne of the 16 canonical gRPC status names, for example ABORTED.
retryableboolWhether the same request may be retried.
effectErrorEffectWhat the failed call committed. One of none, applied, unknown.
retry_after_msint64How long to wait before retrying, when the server knows.
detailsany[]Typed details such as PreconditionFailure or EntitlementDenial.

OperationProgress

FieldTypeWhat it is
percentint32Percent complete, when the controller can tell.
messagestringA customer-safe progress message.
conditionsCondition[]The target's conditions when this progress was read.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/databases/database","spec":{}}'