data

List catalog objects (databases/schemas/relations) for the Explorer's live browse tree.

Lists the databases, schemas, or tables/views reachable through sourceId at one catalog level, for the Explorer's catalog tree (DVT-1807/1809). The relation scope is given as TYPED PARTS (database/schema), each validated against the same strict identifier allowlist as POST /v1/data/describe — never one dotted string (DVT-7). database/schema are optional per level; an absent or unreadable parent degrades to an empty objects list rather than an error.

Same tenant gate, render-session source scoping, and identity resolution as POST /v1/data/query and POST /v1/data/describe: a cross-tenant sourceId returns 404, and the listing runs under the SAME resolved warehouse identity the query path uses (role-mapped Snowflake service, per-user oauth_passthrough, or the shared service identity) — a role-mapped or per-user viewer sees only what THEIR identity can see when browsing, never a broader service-identity view.

Successful listings are cached per resolved identity for 60 seconds (ADR-0012 — the cache key always includes the identity dimension, so two viewers under different identities never share an entry) for auth methods safe to cache under that identity dimension; a Snowflake caller's-rights (spcs_token) or cloud_iam connection is never cached (every distinct caller would otherwise collapse into one shared bucket). POST /v1/data/preview never reads or writes this cache.

post/v1/data/objects

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/data/objects
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

sourceIdstring required

Connection name or UUID (resolved per connection-as-code.md).

level'databases' | 'schemas' | 'relations' required

Catalog level to list.

databasestring

Parent database part, when scoping "schemas" or "relations". Optional — an absent or unreadable parent degrades to an empty list rather than an error. Identifier allowlist: letters, digits, _ or $, up to 255 chars.

schemastring

Parent schema part, when scoping "relations". Optional, same degrade behavior as database. Identifier allowlist: letters, digits, _ or $, up to 255 chars.

includeCommentsboolean

Include each object's warehouse COMMENT, when available.

Response

Catalog objects at the requested level (empty list when not visible/found).

Changes

No recorded changes to this operation across all 1 revision of this API.