Skip to content

Latest commit

 

History

History
333 lines (183 loc) · 11.1 KB

ConnectionApi.md

File metadata and controls

333 lines (183 loc) · 11.1 KB

\ConnectionApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
create_connection POST /v1/connections/create Create a connection between a source and a destination
delete_connection POST /v1/connections/delete Delete a connection
get_connection POST /v1/connections/get Get a connection
list_all_connections_for_workspace POST /v1/connections/list_all Returns all connections for a workspace, including deleted connections.
list_connections_by_actor_definition POST /v1/connections/list_by_actor_definition List all connections that use the provided actor definition
list_connections_for_workspace POST /v1/connections/list Returns all connections for a workspace.
reset_connection POST /v1/connections/reset Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.
reset_connection_stream POST /v1/connections/reset/stream Reset the data for a specific stream in the connection. Deletes data generated by the stream in the destination. Resets any cursors back to initial state.
search_connections POST /v1/connections/search Search connections
sync_connection POST /v1/connections/sync Trigger a manual sync of the connection
update_connection POST /v1/connections/update Update a connection

create_connection

crate::models::ConnectionRead create_connection(connection_create) Create a connection between a source and a destination

Parameters

Name Type Description Required Notes
connection_create ConnectionCreate [required]

Return type

crate::models::ConnectionRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_connection

delete_connection(connection_id_request_body) Delete a connection

Parameters

Name Type Description Required Notes
connection_id_request_body ConnectionIdRequestBody [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_connection

crate::models::ConnectionRead get_connection(connection_id_request_body) Get a connection

Parameters

Name Type Description Required Notes
connection_id_request_body ConnectionIdRequestBody [required]

Return type

crate::models::ConnectionRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_all_connections_for_workspace

crate::models::ConnectionReadList list_all_connections_for_workspace(workspace_id_request_body) Returns all connections for a workspace, including deleted connections.

List connections for workspace, including deleted connections.

Parameters

Name Type Description Required Notes
workspace_id_request_body WorkspaceIdRequestBody [required]

Return type

crate::models::ConnectionReadList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_connections_by_actor_definition

crate::models::ConnectionReadList list_connections_by_actor_definition(actor_definition_request_body) List all connections that use the provided actor definition

Parameters

Name Type Description Required Notes
actor_definition_request_body ActorDefinitionRequestBody [required]

Return type

crate::models::ConnectionReadList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_connections_for_workspace

crate::models::ConnectionReadList list_connections_for_workspace(workspace_id_request_body) Returns all connections for a workspace.

List connections for workspace. Does not return deleted connections.

Parameters

Name Type Description Required Notes
workspace_id_request_body WorkspaceIdRequestBody [required]

Return type

crate::models::ConnectionReadList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_connection

crate::models::JobInfoRead reset_connection(connection_id_request_body) Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state.

Parameters

Name Type Description Required Notes
connection_id_request_body ConnectionIdRequestBody [required]

Return type

crate::models::JobInfoRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_connection_stream

crate::models::JobInfoRead reset_connection_stream(connection_stream_request_body) Reset the data for a specific stream in the connection. Deletes data generated by the stream in the destination. Resets any cursors back to initial state.

Parameters

Name Type Description Required Notes
connection_stream_request_body ConnectionStreamRequestBody [required]

Return type

crate::models::JobInfoRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_connections

crate::models::ConnectionReadList search_connections(connection_search) Search connections

Parameters

Name Type Description Required Notes
connection_search ConnectionSearch [required]

Return type

crate::models::ConnectionReadList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sync_connection

crate::models::JobInfoRead sync_connection(connection_id_request_body) Trigger a manual sync of the connection

Parameters

Name Type Description Required Notes
connection_id_request_body ConnectionIdRequestBody [required]

Return type

crate::models::JobInfoRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_connection

crate::models::ConnectionRead update_connection(connection_update) Update a connection

Apply a patch-style update to a connection. Only fields present on the update request body will be updated. Note that if a catalog is present in the request body, the connection's entire catalog will be replaced with the catalog from the request. This means that to modify a single stream, the entire new catalog containing the updated stream needs to be sent.

Parameters

Name Type Description Required Notes
connection_update ConnectionUpdate [required]

Return type

crate::models::ConnectionRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]