Newer
Older
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# SandboxControlApi
All URIs are relative to *http://localhost/platform-ctrl/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createSandbox**](SandboxControlApi.md#createSandbox) | **POST** /sandboxes | Create a new sandbox
[**createSandboxWithName**](SandboxControlApi.md#createSandboxWithName) | **POST** /sandboxes/{name} | Create a new sandbox
[**deleteSandbox**](SandboxControlApi.md#deleteSandbox) | **DELETE** /sandboxes/{name} | Delete a specific sandbox
[**deleteSandboxList**](SandboxControlApi.md#deleteSandboxList) | **DELETE** /sandboxes | Delete all active sandboxes
[**getSandbox**](SandboxControlApi.md#getSandbox) | **GET** /sandboxes/{name} | Get a specific sandbox
[**getSandboxList**](SandboxControlApi.md#getSandboxList) | **GET** /sandboxes | Get all active sandboxes
<a name="createSandbox"></a>
# **createSandbox**
> Sandbox createSandbox(config)
Create a new sandbox
Create a new sandbox with a server-generated name
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**config** | [**SandboxConfig**](../Models/SandboxConfig.md)| Sandbox configuration information |
### Return type
[**Sandbox**](../Models/Sandbox.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="createSandboxWithName"></a>
# **createSandboxWithName**
> createSandboxWithName(name, config)
Create a new sandbox
Create a new sandbox using provided name
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| Sandbox name | [default to null]
**config** | [**SandboxConfig**](../Models/SandboxConfig.md)| Sandbox configuration information |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="deleteSandbox"></a>
# **deleteSandbox**
> deleteSandbox(name)
Delete a specific sandbox
Delete the sandbox with the provided name
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| Sandbox name | [default to null]
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="deleteSandboxList"></a>
# **deleteSandboxList**
> deleteSandboxList()
Delete all active sandboxes
Delete all active sandboxes
### Parameters
This endpoint does not need any parameter.
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getSandbox"></a>
# **getSandbox**
> Sandbox getSandbox(name)
Get a specific sandbox
Get sandbox information for provided sandbox name
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| Sandbox name | [default to null]
### Return type
[**Sandbox**](../Models/Sandbox.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getSandboxList"></a>
# **getSandboxList**
> SandboxList getSandboxList()
Get all active sandboxes
Returns a list of all active sandboxes
### Parameters
This endpoint does not need any parameter.
### Return type
[**SandboxList**](../Models/SandboxList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json