Menu
Platform
- Accounts and projects
- Regions
- Environments
- Keys and scopes
- Plans, usage and limits
- Errors
- API versions
- API reference
- CLI
- MCP
- Published CLI compatibility
- Terraform
- Management secret deletion
- API keys
- Artifacts
- Connection providers
- Connections
- Envs
- Key versions
- Keys
- Projects
- Secret versions
- Secrets
- Service enablements
- Token exchanges
- Trust policies
AI
Alerts and status pages
App store purchases
Credits
Database
Flags
Generated Assets
Hosting
Monitoring
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Check catalog readiness on a database
Observes aggregate-read coverage using the database's approved reader.
Observes aggregate-read coverage using the database's approved reader. Reads catalog metadata only; never accepts SQL, credentials or row data.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:checkCatalogReadiness - Scope
data:read - Effect
read— nothing is written. - Collection databases
#Request
| Field | Type | What it is |
|---|---|---|
name | string | Exact database name in the authorized environment. Required. |
expected_generation | int64 | A stale scheduled intent yields unknown without connecting. |
#Response
| Field | Type | What it is |
|---|---|---|
resource | string | Exact authorized database name from the owner census. Output only. |
observed_generation | int64 | Resource generation against which the observation is fenced. Output only. |
observed_at | timestamp | Owner clock time at which the observation completed. Output only. |
state | CatalogReadinessState | Whether complete current evidence establishes coverage or a known gap. Output only. One of healthy, unhealthy, unknown. |
reason | CatalogReadinessReason | Finite owner reason; never contains driver errors or credentials. Output only. One of catalog_ready, credential_missing, authority_denied, connect_failed, catalog_unavailable, reachable_zero_declared_functions, declared_function_missing, execute_missing, generation_mismatch, reader_boundary_failed, unsupported_legacy, protected_resource, reader_not_ready, declaration_invalid, platform_owned_policy_excluded. |
coverage_gap | bool | An affirmatively observed coverage defect that can open an episode. Output only. |
transport_reachable | bool | Whether this attempt reached the exact approved database; absent if unobserved. Output only. |
declared_function_count | uint32 | Authoritative declared signatures, present only for a complete catalog read. Output only. |
observed_function_count | uint32 | The number of declared signatures which resolve, not unrelated functions. Output only. |
missing_function_count | uint32 | Declared signatures that did not resolve; absent for unknown observations. Output only. |
execute_missing_count | uint32 | Resolved signatures lacking schema USAGE or function EXECUTE. Output only. |
#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.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:checkCatalogReadiness" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'