WorkspaceApi.md

\WorkspaceApi

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

Method	HTTP request	Description
create_workspace	POST /v1/workspaces/create	Creates a workspace
delete_workspace	POST /v1/workspaces/delete	Deletes a workspace
get_workspace	POST /v1/workspaces/get	Find workspace by ID
get_workspace_by_connection_id	POST /v1/workspaces/get_by_connection_id	Find workspace by connection id
get_workspace_by_slug	POST /v1/workspaces/get_by_slug	Find workspace by slug
list_workspaces	POST /v1/workspaces/list	List all workspaces registered in the current Airbyte deployment
update_workspace	POST /v1/workspaces/update	Update workspace state
update_workspace_feedback	POST /v1/workspaces/tag_feedback_status_as_done	Update workspace feedback state
update_workspace_name	POST /v1/workspaces/update_name	Update workspace name

create_workspace

crate::models::WorkspaceRead create_workspace(workspace_create) Creates a workspace

Parameters

Name	Type	Description	Required	Notes
workspace_create	WorkspaceCreate		[required]

Return type

crate::models::WorkspaceRead

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_workspace

delete_workspace(workspace_id_request_body) Deletes a workspace

Parameters

Name	Type	Description	Required	Notes
workspace_id_request_body	WorkspaceIdRequestBody		[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_workspace

crate::models::WorkspaceRead get_workspace(workspace_id_request_body) Find workspace by ID

Parameters

Name	Type	Description	Required	Notes
workspace_id_request_body	WorkspaceIdRequestBody		[required]

Return type

crate::models::WorkspaceRead

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_workspace_by_connection_id

crate::models::WorkspaceRead get_workspace_by_connection_id(connection_id_request_body) Find workspace by connection id

Parameters

Name	Type	Description	Required	Notes
connection_id_request_body	ConnectionIdRequestBody		[required]

Return type

crate::models::WorkspaceRead

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_workspace_by_slug

crate::models::WorkspaceRead get_workspace_by_slug(slug_request_body) Find workspace by slug

Parameters

Name	Type	Description	Required	Notes
slug_request_body	SlugRequestBody		[required]

Return type

crate::models::WorkspaceRead

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_workspaces

crate::models::WorkspaceReadList list_workspaces() List all workspaces registered in the current Airbyte deployment

Parameters

This endpoint does not need any parameter.

Return type

crate::models::WorkspaceReadList

Authorization

No authorization required

HTTP request headers

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

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

update_workspace

crate::models::WorkspaceRead update_workspace(workspace_update) Update workspace state

Parameters

Name	Type	Description	Required	Notes
workspace_update	WorkspaceUpdate		[required]

Return type

crate::models::WorkspaceRead

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_workspace_feedback

update_workspace_feedback(workspace_give_feedback) Update workspace feedback state

Parameters

Name	Type	Description	Required	Notes
workspace_give_feedback	WorkspaceGiveFeedback		[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]

update_workspace_name

crate::models::WorkspaceRead update_workspace_name(workspace_update_name) Update workspace name

Parameters

Name	Type	Description	Required	Notes
workspace_update_name	WorkspaceUpdateName		[required]

Return type

crate::models::WorkspaceRead

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]