Skip to content

DestinationApi.md

Latest commit

 

History

History
298 lines (164 loc) · 9.22 KB

DestinationApi.md

File metadata and controls

298 lines (164 loc) · 9.22 KB

\DestinationApi

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

Method HTTP request Description
check_connection_to_destination POST /v1/destinations/check_connection Check connection to the destination
check_connection_to_destination_for_update POST /v1/destinations/check_connection_for_update Check connection for a proposed update to a destination
clone_destination POST /v1/destinations/clone Clone destination
create_destination POST /v1/destinations/create Create a destination
delete_destination POST /v1/destinations/delete Delete the destination
get_destination POST /v1/destinations/get Get configured destination
list_destinations_for_workspace POST /v1/destinations/list List configured destinations for a workspace
partial_update_destination POST /v1/destinations/partial_update Update a destination partially
search_destinations POST /v1/destinations/search Search destinations
update_destination POST /v1/destinations/update Update a destination

check_connection_to_destination

crate::models::CheckConnectionRead check_connection_to_destination(destination_id_request_body) Check connection to the destination

Parameters

Name Type Description Required Notes
destination_id_request_body DestinationIdRequestBody [required]

Return type

crate::models::CheckConnectionRead

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]

check_connection_to_destination_for_update

crate::models::CheckConnectionRead check_connection_to_destination_for_update(destination_update) Check connection for a proposed update to a destination

Parameters

Name Type Description Required Notes
destination_update DestinationUpdate [required]

Return type

crate::models::CheckConnectionRead

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]

clone_destination

crate::models::DestinationRead clone_destination(destination_clone_request_body) Clone destination

Parameters

Name Type Description Required Notes
destination_clone_request_body DestinationCloneRequestBody [required]

Return type

crate::models::DestinationRead

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]

create_destination

crate::models::DestinationRead create_destination(destination_create) Create a destination

Parameters

Name Type Description Required Notes
destination_create DestinationCreate [required]

Return type

crate::models::DestinationRead

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_destination

delete_destination(destination_id_request_body) Delete the destination

Parameters

Name Type Description Required Notes
destination_id_request_body DestinationIdRequestBody [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_destination

crate::models::DestinationRead get_destination(destination_id_request_body) Get configured destination

Parameters

Name Type Description Required Notes
destination_id_request_body DestinationIdRequestBody [required]

Return type

crate::models::DestinationRead

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_destinations_for_workspace

crate::models::DestinationReadList list_destinations_for_workspace(workspace_id_request_body) List configured destinations for a workspace

Parameters

Name Type Description Required Notes
workspace_id_request_body WorkspaceIdRequestBody [required]

Return type

crate::models::DestinationReadList

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]

partial_update_destination

crate::models::DestinationRead partial_update_destination(partial_destination_update) Update a destination partially

Parameters

Name Type Description Required Notes
partial_destination_update PartialDestinationUpdate [required]

Return type

crate::models::DestinationRead

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_destinations

crate::models::DestinationReadList search_destinations(destination_search) Search destinations

Parameters

Name Type Description Required Notes
destination_search DestinationSearch [required]

Return type

crate::models::DestinationReadList

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_destination

crate::models::DestinationRead update_destination(destination_update) Update a destination

Parameters

Name Type Description Required Notes
destination_update DestinationUpdate [required]

Return type

crate::models::DestinationRead

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]