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 isDatabase
Request
| Field | Type | What it is |
|---|---|---|
database | Database | The database to update; name identifies it. Required. |
update_mask | field_mask | The fields to write; unset writes every populated field. |
allow_missing | bool | Create the Resource when it does not exist (declarative upsert). |
validate_only | bool | Validate and return the result without writing anything. |
Database
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/databases/{database}. |
meta | ResourceMeta | Resource metadata. |
spec | DatabaseSpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
DatabaseSpec
| Field | Type | What it is |
|---|---|---|
postgres_version | string | The Postgres major version, for example 17; default the newest supported. |
compute_units | double | Compute size in units; default the plan's. max_connections derives from it. |
region | string | The region; default the project's home region. Changing it moves the data by signed export and import. |
deletion_protection | bool | While set, Delete fails with DELETION_PROTECTED. |
client_allowlist | string[] | 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_set | bool | Stores 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
| Field | Type | What it is |
|---|---|---|
name | string | {parent-of-target}/operations/{operation}. |
target | string | The name of the Resource being changed. |
target_generation | int64 | The generation this Operation waits for. |
verb | OperationVerb | What the Operation does. One of create, update, delete, custom. |
custom_verb | string | The custom method verb when verb is CUSTOM, for example revoke. |
done | bool | Whether the Operation has finished. |
create_time | timestamp | When the Operation started. |
end_time | timestamp | When the Operation finished. |
response | any | The settled Resource (or Empty for a delete). One of the result group. |
error | ProblemDetails | The failure, as the one error body. One of the result group. |
progress | OperationProgress | Progress while not done. |
ProblemDetails
| Field | Type | What it is |
|---|---|---|
type | string | https://sylphx.com/docs/errors/<code in kebab-case>. |
title | string | A short customer-safe summary of the problem class. |
status | int32 | The HTTP status, fixed by grpc_status. |
detail | string | A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data. |
instance | string | The request id (Sylphx-Request-Id). |
code | string | The stable UPPER_SNAKE code, one of ErrorCode without its prefix. |
grpc_status | string | One of the 16 canonical gRPC status names, for example ABORTED. |
retryable | bool | Whether the same request may be retried. |
effect | ErrorEffect | What the failed call committed. One of none, applied, unknown. |
retry_after_ms | int64 | How long to wait before retrying, when the server knows. |
details | any[] | Typed details such as PreconditionFailure or EntitlementDenial. |
OperationProgress
| Field | Type | What it is |
|---|---|---|
percent | int32 | Percent complete, when the controller can tell. |
message | string | A customer-safe progress message. |
conditions | Condition[] | The target's conditions when this progress was read. |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.FAILED_PRECONDITION— A released manifest owns a requested resource field. Change the declaration in the named file and key path, then release.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
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":{}}'