Reference

Databases

A Database is one customer Postgres.

Checked 2026-09-28

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

Field	Type	What it is
name	string	orgs/{org}/projects/{project}/envs/{env}/databases/{database}.
uid	string	db_<cell><ulid>; never reused. Output only.
meta	ResourceMeta	Resource metadata.
spec	DatabaseSpec	Desired state. Required.
status	DatabaseStatus	Observed 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.

Method	Call	What it does
GET	get	Gets a database.
GET	list	Lists databases in a environment.
POST	create	Creates a database. The Operation is done when the controller settles it.
PATCH	update	Updates a database.
DELETE	delete	Deletes a database. Fails while spec.deletion_protection is set.
POST	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	rotate_credentials	Replaces the database's engine credentials; the old ones stop working once the new ones are served.
POST	restore	Restores 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

#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.

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