hotdata 0.1.2

Powerful data platform API for datasets, queries, and analytics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

# \SandboxesApi

All URIs are relative to *https://api.hotdata.dev*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_sandbox**](SandboxesApi.md#create_sandbox) | **POST** /v1/sandboxes | Create a sandbox
[**delete_sandbox**](SandboxesApi.md#delete_sandbox) | **DELETE** /v1/sandboxes/{public_id} | Delete sandbox
[**get_sandbox**](SandboxesApi.md#get_sandbox) | **GET** /v1/sandboxes/{public_id} | Get sandbox
[**list_sandboxes**](SandboxesApi.md#list_sandboxes) | **GET** /v1/sandboxes | List sandboxes
[**update_sandbox**](SandboxesApi.md#update_sandbox) | **PATCH** /v1/sandboxes/{public_id} | Update sandbox



## create_sandbox

> models::SandboxResponse create_sandbox(create_sandbox_request)
Create a sandbox

Creates a sandbox in the requested workspace. The returned `public_id` is the value to pass as `X-Session-Id` on scoped ops.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_sandbox_request** | [**CreateSandboxRequest**](CreateSandboxRequest.md) |  | [required] |

### Return type

[**models::SandboxResponse**](SandboxResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

[[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)


## delete_sandbox

> models::DeleteSandboxResponse delete_sandbox(public_id)
Delete sandbox

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**public_id** | **String** | Public id of the sandbox. | [required] |

### Return type

[**models::DeleteSandboxResponse**](DeleteSandboxResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

[[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)


## get_sandbox

> models::SandboxResponse get_sandbox(public_id)
Get sandbox

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**public_id** | **String** | Public id of the sandbox. | [required] |

### Return type

[**models::SandboxResponse**](SandboxResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

[[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)


## list_sandboxes

> models::ListSandboxesResponse list_sandboxes()
List sandboxes

Lists sandboxes for the caller in the requested workspace.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListSandboxesResponse**](ListSandboxesResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

[[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)


## update_sandbox

> models::SandboxResponse update_sandbox(public_id, update_sandbox_request)
Update sandbox

Partial update. Only the provided fields are changed.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**public_id** | **String** | Public id of the sandbox. | [required] |
**update_sandbox_request** | [**UpdateSandboxRequest**](UpdateSandboxRequest.md) |  | [required] |

### Return type

[**models::SandboxResponse**](SandboxResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

[[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)