You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/WorkspacesApi.md
+79Lines changed: 79 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.hotdata.dev*
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
7
[**create_workspace**](WorkspacesApi.md#create_workspace) | **POST** /v1/workspaces | Create a workspace
8
+
[**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /v1/workspaces/{public_id} | Delete a workspace
8
9
[**list_workspaces**](WorkspacesApi.md#list_workspaces) | **GET** /v1/workspaces | List workspaces
9
10
10
11
@@ -92,6 +93,84 @@ Name | Type | Description | Notes
92
93
93
94
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
94
95
96
+
# **delete_workspace**
97
+
> delete_workspace(public_id)
98
+
99
+
Delete a workspace
100
+
101
+
Hard-deletes the workspace. Namespace, storage, and catalog deprovisioning runs asynchronously after the row is removed.
102
+
103
+
### Example
104
+
105
+
* Bearer Authentication (BearerAuth):
106
+
107
+
```python
108
+
import hotdata
109
+
from hotdata.rest import ApiException
110
+
from pprint import pprint
111
+
112
+
# Defining the host is optional and defaults to https://api.hotdata.dev
113
+
# See configuration.py for a list of all supported configuration parameters.
114
+
configuration = hotdata.Configuration(
115
+
host="https://api.hotdata.dev"
116
+
)
117
+
118
+
# The client must configure the authentication and authorization parameters
119
+
# in accordance with the API server security policy.
120
+
# Examples for each auth method are provided below, use the example that
121
+
# satisfies your auth use case.
122
+
123
+
# Configure Bearer authorization: BearerAuth
124
+
configuration = hotdata.Configuration(
125
+
access_token= os.environ["BEARER_TOKEN"]
126
+
)
127
+
128
+
# Enter a context with an instance of the API client
129
+
with hotdata.ApiClient(configuration) as api_client:
130
+
# Create an instance of the API class
131
+
api_instance = hotdata.WorkspacesApi(api_client)
132
+
public_id ='public_id_example'# str | Public id of the workspace.
133
+
134
+
try:
135
+
# Delete a workspace
136
+
api_instance.delete_workspace(public_id)
137
+
exceptExceptionas e:
138
+
print("Exception when calling WorkspacesApi->delete_workspace: %s\n"% e)
**public_id** | **str**| Public id of the workspace. |
149
+
150
+
### Return type
151
+
152
+
void (empty response body)
153
+
154
+
### Authorization
155
+
156
+
[BearerAuth](../README.md#BearerAuth)
157
+
158
+
### HTTP request headers
159
+
160
+
-**Content-Type**: Not defined
161
+
-**Accept**: application/json
162
+
163
+
### HTTP response details
164
+
165
+
| Status code | Description | Response headers |
166
+
|-------------|-------------|------------------|
167
+
**204** | Workspace deleted | - |
168
+
**401** | Missing or invalid authorization | - |
169
+
**403** | Workspace-scoped tokens are not allowed | - |
170
+
**404** | Workspace not found, or caller is not a member of its organization | - |
171
+
172
+
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
0 commit comments