Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Query catalog targets on a database

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

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

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases:queryCatalogTargets
  • Scope data:read
  • Effect read — nothing is written.
  • Collection databases

#Request

FieldTypeWhat it is
parentstringExact organization, project and environment parent. Required.
page_sizeint32Maximum targets to return; defaults to 100 and is capped at 1000.
page_tokenstringOpaque cursor from the preceding page in the same environment.

#Response

FieldTypeWhat it is
targetsDatabaseCatalogTarget[]Targets in stable resource order, including protected and legacy entries.
next_page_tokenstringCursor for the next page; empty when the census is complete.

#DatabaseCatalogTarget

FieldTypeWhat it is
resourcestringExact authorized database name from the owner census. Output only.
observed_generationint64Resource generation against which the observation is fenced. Output only.
collection_reasonCatalogReadinessReasonProtected and unsupported entries stay in the census with an explicit reason. CATALOG_READY here means pending collection, not observed reader eligibility or proven health. 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.
legacyboolThe existing resource binding is authoritative rather than a canonical Data record. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases:queryCatalogTargets" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'