Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List databases
Lists databases in a environment.
Lists databases in a environment.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases - Scope
data:read - Effect
read— nothing is written. - Collection databases
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
databasesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels, filterable fields, and Ready. |
order_by | string | AIP-132 ordering over filterable fields. |
#Response
| Field | Type | What it is |
|---|---|---|
databases | Database[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#Database
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
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. |
creator | string | The principal that created the Resource. Output only. |
#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. |
#DatabaseStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
state | DatastoreState | Serving state. Output only. One of provisioning, active, idle, moving, deleting. |
ref | string | The routing ref: the first DNS label of the datastore's endpoint. Output only. |
host | string | The endpoint host, {ref}.sylphx.net; {ref}-direct is the direct profile. Output only. |
cell | string | The cell the datastore is placed on. Output only. |
storage_bytes | int64 | Bytes stored, at the last usage sample. Output only. |
max_connections | int32 | Derived from compute size; not customer config. Output only. |
earliest_restore_time | timestamp | The earliest point :restore accepts. Output only. |
#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.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases" \
-H "Authorization: Bearer $SYLPHX_API_KEY"