Connected sources

A connected source is a third-party system the platform observes. You create the source against an auth integration, browse it, then connect one external file or a container (a folder-like selection). The platform tracks what is there and syncs it.

ResourceTypeDto values for this surface are connected_resource and connected_container.

Uploading a local metadata-pointer file as a model, artifact, or file is Connected resources. Secure Connections to a partner deployment are Remote connections on the V3Client reference.

Methods below are on V3Client.

Sources

create_connected_source()

Creates a connected source.

• Parameters:

  • connected_source_create_dto (ConnectedSourceCreateDto) – (required). connector_key and auth_integration_id are required. Optional: name, probe_policy, credential_kind.
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedSourceDto

get_connected_source()

• Parameters:

  • connected_source_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedSourceDto

list_connected_sources()

• Parameters:

  • show_archived (bool, optional)
  • cursor (str, optional)
  • size (int, optional)
  • include_total (bool, optional)
  • http_request_timeout_secs (int, optional)

• Return Type: CursorPageConnectedSourceDto

archive_connected_source()

• Parameters:

  • connected_source_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedSourceDto

browse_connected_source()

Lists entries under a locator. locator is a JSON-encoded, connector-specific address. depth defaults to 1 (direct children). A container that does not fit the response comes back with children null so you can browse it yourself.

• Parameters:

  • connected_source_id (str) – (required)
  • locator (str) – JSON-encoded address. (required)
  • depth (int, optional) – Minimum 1. Default 1.
  • http_request_timeout_secs (int, optional)

• Return Type: list of BrowseEntryDto

Connections

A connection is one external file (create_connection) or the handle you use to read status, lineage, and selection.

create_connection()

Connects a single external file.

• Parameters:

  • connected_source_id (str) – (required)
  • connected_resource_create_dto (ConnectedResourceCreateDto) – (required). connector and locator (a dict) are required. name is optional.
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedResourceDto

get_connection()

• Parameters:

  • connected_resource_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedResourceDto

list_connections()

• Parameters:

  • connected_source_id (str, optional)
  • root_containers_only (bool, optional)
  • show_archived (bool, optional)
  • cursor (str, optional)
  • size (int, optional)
  • include_total (bool, optional)
  • http_request_timeout_secs (int, optional)

• Return Type: CursorPageConnectedResourceDto

delete_connection()

Soft-stops a connection.

• Parameters:

  • connected_resource_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedResourceDto

browse_connection()

Browses an existing container connection. depth defaults to 1.

• Parameters:

  • connected_resource_id (str) – (required)
  • depth (int, optional)
  • http_request_timeout_secs (int, optional)

• Return Type: list of BrowseEntryDto

sync_connection()

Syncs a connection now.

• Parameters:

  • connected_resource_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedResourceStatusDto

get_connection_status()

• Parameters:

  • connected_resource_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedResourceStatusDto

get_connection_lineage()

Returns the ancestor containers of a connection.

• Parameters:

  • connected_resource_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: list of LineageEntryDto

download_connected_content()

Downloads a connected revision. t is a signed, short-lived grant. The generated method declares a None return: the HTTP 200 body has no schema, and the client reads and discards it.

• Parameters:

  • file_revision_id (str) – Connected resource revision. (required)
  • t (str) – Signed grant. (required)
  • http_request_timeout_secs (int, optional)

• Return Type: None

Containers

create_container()

Commits a recursive selection under a connected source and creates a connected container. children is the full list of checked provider child ids (files and folders, at every depth), at most 1000 entries.

• Parameters:

  • connected_source_id (str) – (required)
  • connected_container_create_dto (ConnectedContainerCreateDto) – (required). connector, locator, and children are required. Optional: name, granularity, extraction_mode, prefer_recursive_list, subscribe.
  • http_request_timeout_secs (int, optional)

• Return Type: ConnectedContainerDto

get_connection_selection()

Returns a container connection's include-list.

• Parameters:

  • connected_resource_id (str) – (required)
  • http_request_timeout_secs (int, optional)

• Return Type: ContainerSelectionDto

update_connection_selection()

Adds and/or removes provider child ids. Removal stops future syncing and marks the membership removed. It does not delete the underlying resource.

• Parameters:

  • connected_resource_id (str) – (required)
  • selection_update_dto (SelectionUpdateDto) – (required). Optional lists add and remove.
  • http_request_timeout_secs (int, optional)

• Return Type: ContainerSelectionDto

list_container_snapshots()

Lists a container connection's snapshots.

• Parameters:

  • connected_resource_id (str) – (required)
  • file_revision_id (str, optional)
  • cursor (str, optional)
  • size (int, optional)
  • include_total (bool, optional)
  • http_request_timeout_secs (int, optional)

• Return Type: CursorPageContainerSnapshotDto

list_container_snapshot_children()

Lists what one container snapshot froze.

• Parameters:

  • connected_resource_id (str) – (required)
  • snapshot_id (str) – (required)
  • claimed_by_me (bool, optional) – When true, only children the caller had selected when this snapshot was taken.
  • cursor (str, optional)
  • size (int, optional)
  • include_total (bool, optional)
  • http_request_timeout_secs (int, optional)

• Return Type: CursorPageContainerSnapshotChildDto