Skip to main content

:::note Generated reference Generated from honeyframeapi 0.1.8 — do not edit by hand. :::

honeyframeapi.connector

Connector handle — manage org-level data connections.

Create, test, update, rotate and delete the connections your org uses to reach databases, APIs and model providers. Connectors are org-scoped in Honeyframe (no per-project ACL), so they hang off the client:

cat = client.list_connector_catalog()                  # available types
conn = client.create_connector("SAP Prod", "postgresql",
                               config={"host": "…", "database": "…"})
print(conn.test())                                     # {status, message, latency_ms}

class Connector​

Connector.name​

property

name: str

Connector.connector_type​

property

connector_type: str

Connector.reload()​

reload() -> Connector

Connector.get_settings()​

get_settings() -> dict

Connector.update()​

update(**fields) -> dict

Patch connector fields (name, description, config, status, output_schemas).

Connector.test()​

test(config: Optional[dict] = None) -> dict

Test connectivity; returns {status, message, latency_ms, …}.

Connector.delete()​

delete() -> dict

Connector.set_my_credentials()​

set_my_credentials(secrets: dict) -> dict

Upsert the CALLER's personal secrets for this connector. secrets maps the connector type's secret fields → values (AES-GCM encrypted server-side). Only valid on a credentials_mode='per_user' connector. Returns {saved, connector_id, fields}. Use HoneyframeClient.list_my_credentials to see fill status.

Connector.delete_my_credentials()​

delete_my_credentials() -> dict

Remove the caller's stored secrets for this connector ({deleted}).

Connector.rotate()​

rotate(config: dict, *, rotation_reason: str = '', force_save: bool = False) -> dict

Rotate this connector's secrets with test-before-commit. config carries the new secret fields — •••••••• placeholders keep the current value. A failing dry-run health check aborts (no DB write) unless force_save=True. The old blob is snapshotted to history. Returns {rotated, test_status, test_result}.

Connector.secret_history()​

secret_history(*, limit: int = 20) -> list[dict]

Rotation history, newest first — metadata only, never plaintext ({history_id, rotated_at, rotation_reason, test_status, rotated_by, had_secrets}).

Connector.rollback_secret()​

rollback_secret(history_id: int) -> dict

Restore secrets + config from a secret_history row. Re-tests the restored config first and aborts on failure (no force — a rollback should land on a known-good state). Returns {rolled_back, test_result}.

Verified against honeyframeapi 0.1.8.