Skip to content
Console
On this page

Databases

A Database is one customer Postgres.

A Database is one customer Postgres. Silo: each has its own engine, credentials, backup, region, and deletion. The customer sets no instance class, disk, replica, or max_connections; they derive from compute size. An idle free-tier database stops and the next connect wakes it.

Service Sylphx Data · Resource type data.sylphx.com/Database · Name pattern orgs/{org}/projects/{project}/envs/{env}/databases/{database} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/databases/{database}.
uidstringdb_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specDatabaseSpecDesired state. Required.
statusDatabaseStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a database.
GETlistLists databases in a environment.
POSTcheck_catalog_readinessObserves aggregate-read coverage using the database's approved reader. Reads catalog metadata only; never accepts SQL, credentials or row data.
POSTquery_catalog_targetsPages the complete authorized production database population, including legacy bindings and protected resources which cannot be observed.
POSTcreateCreates a database. The Operation is done when the controller settles it.
PATCHupdateUpdates 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.
DELETEdeleteDeletes a database. Fails while spec.deletion_protection is set.
POSTconnectReturns how to connect to the database: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.
POSTrotate_credentialsReplaces the database's engine credentials; the old ones stop working once the new ones are served.
POSTrestoreRestores the database in place to a point in time inside its retention window; the database is unavailable while it restores.

get

Gets a database.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database · scope data:read · effect read · Request, response and examples

list

Lists databases in a environment.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases · scope data:read · effect read · paginated · Request, response and examples

check_catalog_readiness

Observes aggregate-read coverage using the database's approved reader. Reads catalog metadata only; never accepts SQL, credentials or row data.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:checkCatalogReadiness · scope data:read · effect read · Request, response and examples

query_catalog_targets

Pages the complete authorized production database population, including legacy bindings and protected resources which cannot be observed.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases:queryCatalogTargets · scope data:read · effect read · Request, response and examples

create

Creates a database. The Operation is done when the controller settles it.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases · scope data:write · effect write · long-running · Request, response and examples

update

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.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database · scope data:write · effect write · long-running · Request, response and examples

delete

Deletes a database. Fails while spec.deletion_protection is set.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database · scope data:write · effect destructive · long-running · Request, response and examples

connect

Returns how to connect to the database: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:connect · scope data:write · effect read · Request, response and examples

rotate_credentials

Replaces the database's engine credentials; the old ones stop working once the new ones are served.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:rotateCredentials · scope data:write · effect write · validate_only · long-running · Request, response and examples

restore

Restores the database in place to a point in time inside its retention window; the database is unavailable while it restores.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:restore · scope data:write · effect destructive · validate_only · long-running · Request, response and examples