v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-connectors

Set Selection Endpoint

Set entity selection for indexing.

This determines which entities (databases, schemas, tables) from the discovered schema will be indexed and available for querying.

Special Selection Mode:

  • Use "*" in selected_paths to select ALL entities (wildcard selection)
  • Example: {"selected_paths": ["*"]} will index the entire discovered schema

Flow:

  1. Load current connector and schema_structure
  2. Prune schema tree to only include selected paths (or use full schema if "*")
  3. Update DB with:
    • selected_entity_paths (user's input)
    • selected_schema_structure (pruned tree or full schema)
    • selection_schema_version (snapshot of current schema_version)
    • selected_schema_version (incremented counter)
  4. Return pruned schema

After selection, user must call POST /{connector_id}/index to apply changes.

Requirements:

  • User must have admin access to connector's org
  • Connector must exist with schema_structure (discovery completed)

WARNING: This does NOT auto-include FK targets! If you select tables with foreign key relationships, you must manually select the referenced tables or risk dangling references in the indexed schema.

post/v1/connectors/{connector_id}/selection

Path parameters

connector_idstring required

Request body

selected_pathsstring[] required

Discovered paths to replicate. Use ["*"] to select everything.

Response

The connector row with the applied selection fields.

idstring required

Connector ID.

org_idstring required

Organization the connector belongs to.

project_idstring nullable

Project the connector belongs to.

namestring required

Connector name.

service_namestring required

Service type. postgresql today.

statusstring nullable

Current connector status.

created_atstring nullable

When the connector was created.

can_updateboolean nullable

Whether the caller may update this connector.

can_deleteboolean nullable

Whether the caller may delete this connector.