Class: DaytonaApiClient::SandboxApi

Inherits:
Object
  • Object
show all
Defined in:
lib/daytona_api_client/api/sandbox_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SandboxApi

Returns a new instance of SandboxApi.



19
20
21
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#archive_sandbox(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Archive sandbox

Parameters:

  • sandbox_id_or_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



27
28
29
30
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 27

def archive_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = archive_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

#archive_sandbox_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Archive sandbox

Parameters:

  • sandbox_id_or_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



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
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 37

def archive_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.archive_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.archive_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/archive'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.archive_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#archive_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_backup(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Create sandbox backup

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



91
92
93
94
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 91

def create_backup(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = create_backup_with_http_info(sandbox_id_or_name, opts)
  data
end

#create_backup_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Create sandbox backup

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



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
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 101

def create_backup_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.create_backup ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.create_backup"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/backup'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.create_backup",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#create_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sandbox(create_sandbox, opts = {}) ⇒ Sandbox

Create a new sandbox

Parameters:

  • create_sandbox (CreateSandbox)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



155
156
157
158
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 155

def create_sandbox(create_sandbox, opts = {})
  data, _status_code, _headers = create_sandbox_with_http_info(create_sandbox, opts)
  data
end

#create_sandbox_with_http_info(create_sandbox, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Create a new sandbox

Parameters:

  • create_sandbox (CreateSandbox)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 165

def create_sandbox_with_http_info(create_sandbox, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.create_sandbox ...'
  end
  # verify the required parameter 'create_sandbox' is set
  if @api_client.config.client_side_validation && create_sandbox.nil?
    fail ArgumentError, "Missing the required parameter 'create_sandbox' when calling SandboxApi.create_sandbox"
  end
  # resource path
  local_var_path = '/sandbox'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_sandbox)

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.create_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#create_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_ssh_access(sandbox_id_or_name, opts = {}) ⇒ SshAccessDto

Create SSH access for sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :expires_in_minutes (Float) —

    Expiration time in minutes (default: 60)

Returns:



225
226
227
228
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 225

def create_ssh_access(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = create_ssh_access_with_http_info(sandbox_id_or_name, opts)
  data
end

#create_ssh_access_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(SshAccessDto, Integer, Hash)>

Create SSH access for sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :expires_in_minutes (Float) —

    Expiration time in minutes (default: 60)

Returns:

  • (Array<(SshAccessDto, Integer, Hash)>) —

    SshAccessDto data, response status code and response headers



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 236

def create_ssh_access_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.create_ssh_access ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.create_ssh_access"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ssh-access'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expiresInMinutes'] = opts[:'expires_in_minutes'] if !opts[:'expires_in_minutes'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SshAccessDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.create_ssh_access",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#create_ssh_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sandbox(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Delete sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



291
292
293
294
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 291

def delete_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = delete_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

#delete_sandbox_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Delete sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 301

def delete_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.delete_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.delete_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.delete_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#delete_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expire_signed_port_preview_url(sandbox_id_or_name, port, token, opts = {}) ⇒ nil

Expire signed preview URL for a sandbox port

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • port (Integer) —

    Port number to expire signed preview URL for

  • token (String) —

    Token to expire signed preview URL for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (nil) 


357
358
359
360
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 357

def expire_signed_port_preview_url(sandbox_id_or_name, port, token, opts = {})
  expire_signed_port_preview_url_with_http_info(sandbox_id_or_name, port, token, opts)
  nil
end

#expire_signed_port_preview_url_with_http_info(sandbox_id_or_name, port, token, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Expire signed preview URL for a sandbox port

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • port (Integer) —

    Port number to expire signed preview URL for

  • token (String) —

    Token to expire signed preview URL for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 369

def expire_signed_port_preview_url_with_http_info(sandbox_id_or_name, port, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.expire_signed_port_preview_url ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.expire_signed_port_preview_url"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling SandboxApi.expire_signed_port_preview_url"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling SandboxApi.expire_signed_port_preview_url"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ports/{port}/signed-preview-url/{token}/expire'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'port' + '}', CGI.escape(port.to_s)).sub('{' + 'token' + '}', CGI.escape(token.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.expire_signed_port_preview_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#expire_signed_port_preview_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_build_logs(sandbox_id_or_name, opts = {}) ⇒ nil

Get build logs This endpoint is deprecated. Use ‘getBuildLogsUrl` instead.

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :follow (Boolean) —

    Whether to follow the logs stream

Returns:

  • (nil) 


431
432
433
434
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 431

def get_build_logs(sandbox_id_or_name, opts = {})
  get_build_logs_with_http_info(sandbox_id_or_name, opts)
  nil
end

#get_build_logs_url(sandbox_id_or_name, opts = {}) ⇒ Url

Get build logs URL

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



496
497
498
499
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 496

def get_build_logs_url(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = get_build_logs_url_with_http_info(sandbox_id_or_name, opts)
  data
end

#get_build_logs_url_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Url, Integer, Hash)>

Get build logs URL

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Url, Integer, Hash)>) —

    Url data, response status code and response headers



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 506

def get_build_logs_url_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_build_logs_url ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.get_build_logs_url"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/build-logs-url'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Url'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_build_logs_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_build_logs_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_build_logs_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get build logs This endpoint is deprecated. Use &#x60;getBuildLogsUrl&#x60; instead.

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :follow (Boolean) —

    Whether to follow the logs stream

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 443

def get_build_logs_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_build_logs ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.get_build_logs"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/build-logs'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'follow'] = opts[:'follow'] if !opts[:'follow'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_build_logs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_build_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_port_preview_url(sandbox_id_or_name, port, opts = {}) ⇒ PortPreviewUrl

Get preview URL for a sandbox port

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • port (Float) —

    Port number to get preview URL for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



561
562
563
564
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 561

def get_port_preview_url(sandbox_id_or_name, port, opts = {})
  data, _status_code, _headers = get_port_preview_url_with_http_info(sandbox_id_or_name, port, opts)
  data
end

#get_port_preview_url_with_http_info(sandbox_id_or_name, port, opts = {}) ⇒ Array<(PortPreviewUrl, Integer, Hash)>

Get preview URL for a sandbox port

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • port (Float) —

    Port number to get preview URL for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(PortPreviewUrl, Integer, Hash)>) —

    PortPreviewUrl data, response status code and response headers



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 572

def get_port_preview_url_with_http_info(sandbox_id_or_name, port, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_port_preview_url ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.get_port_preview_url"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling SandboxApi.get_port_preview_url"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ports/{port}/preview-url'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'port' + '}', CGI.escape(port.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PortPreviewUrl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_port_preview_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_port_preview_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Get sandbox details

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :verbose (Boolean) —

    Include verbose output

Returns:



631
632
633
634
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 631

def get_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = get_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

#get_sandbox_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Get sandbox details

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :verbose (Boolean) —

    Include verbose output

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 642

def get_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.get_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'verbose'] = opts[:'verbose'] if !opts[:'verbose'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandboxes_for_runner(opts = {}) ⇒ Array<Sandbox>

Get sandboxes for the authenticated runner

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :states (String) —

    Comma-separated list of sandbox states to filter by

  • :skip_reconciling_sandboxes (Boolean) —

    Skip sandboxes where state differs from desired state

Returns:



698
699
700
701
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 698

def get_sandboxes_for_runner(opts = {})
  data, _status_code, _headers = get_sandboxes_for_runner_with_http_info(opts)
  data
end

#get_sandboxes_for_runner_with_http_info(opts = {}) ⇒ Array<(Array<Sandbox>, Integer, Hash)>

Get sandboxes for the authenticated runner

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :states (String) —

    Comma-separated list of sandbox states to filter by

  • :skip_reconciling_sandboxes (Boolean) —

    Skip sandboxes where state differs from desired state

Returns:

  • (Array<(Array<Sandbox>, Integer, Hash)>) —

    Array<Sandbox> data, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 709

def get_sandboxes_for_runner_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandboxes_for_runner ...'
  end
  # resource path
  local_var_path = '/sandbox/for-runner'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'states'] = opts[:'states'] if !opts[:'states'].nil?
  query_params[:'skipReconcilingSandboxes'] = opts[:'skip_reconciling_sandboxes'] if !opts[:'skip_reconciling_sandboxes'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Sandbox>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandboxes_for_runner",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_sandboxes_for_runner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_signed_port_preview_url(sandbox_id_or_name, port, opts = {}) ⇒ SignedPortPreviewUrl

Get signed preview URL for a sandbox port

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • port (Integer) —

    Port number to get signed preview URL for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :expires_in_seconds (Integer) —

    Expiration time in seconds (default: 60 seconds)

Returns:



763
764
765
766
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 763

def get_signed_port_preview_url(sandbox_id_or_name, port, opts = {})
  data, _status_code, _headers = get_signed_port_preview_url_with_http_info(sandbox_id_or_name, port, opts)
  data
end

#get_signed_port_preview_url_with_http_info(sandbox_id_or_name, port, opts = {}) ⇒ Array<(SignedPortPreviewUrl, Integer, Hash)>

Get signed preview URL for a sandbox port

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • port (Integer) —

    Port number to get signed preview URL for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :expires_in_seconds (Integer) —

    Expiration time in seconds (default: 60 seconds)

Returns:

  • (Array<(SignedPortPreviewUrl, Integer, Hash)>) —

    SignedPortPreviewUrl data, response status code and response headers



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 775

def get_signed_port_preview_url_with_http_info(sandbox_id_or_name, port, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_signed_port_preview_url ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.get_signed_port_preview_url"
  end
  # verify the required parameter 'port' is set
  if @api_client.config.client_side_validation && port.nil?
    fail ArgumentError, "Missing the required parameter 'port' when calling SandboxApi.get_signed_port_preview_url"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ports/{port}/signed-preview-url'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'port' + '}', CGI.escape(port.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expiresInSeconds'] = opts[:'expires_in_seconds'] if !opts[:'expires_in_seconds'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SignedPortPreviewUrl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_signed_port_preview_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_signed_port_preview_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_toolbox_proxy_url(sandbox_id, opts = {}) ⇒ ToolboxProxyUrl

Get toolbox proxy URL for a sandbox

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



834
835
836
837
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 834

def get_toolbox_proxy_url(sandbox_id, opts = {})
  data, _status_code, _headers = get_toolbox_proxy_url_with_http_info(sandbox_id, opts)
  data
end

#get_toolbox_proxy_url_with_http_info(sandbox_id, opts = {}) ⇒ Array<(ToolboxProxyUrl, Integer, Hash)>

Get toolbox proxy URL for a sandbox

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(ToolboxProxyUrl, Integer, Hash)>) —

    ToolboxProxyUrl data, response status code and response headers



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 844

def get_toolbox_proxy_url_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_toolbox_proxy_url ...'
  end
  # verify the required parameter 'sandbox_id' is set
  if @api_client.config.client_side_validation && sandbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id' when calling SandboxApi.get_toolbox_proxy_url"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/toolbox-proxy-url'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ToolboxProxyUrl'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.get_toolbox_proxy_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#get_toolbox_proxy_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_sandboxes(opts = {}) ⇒ Array<Sandbox>

List all sandboxes

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :verbose (Boolean) —

    Include verbose output

  • :labels (String) —

    JSON encoded labels to filter by

  • :include_errored_deleted (Boolean) —

    Include errored and deleted sandboxes

Returns:



900
901
902
903
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 900

def list_sandboxes(opts = {})
  data, _status_code, _headers = list_sandboxes_with_http_info(opts)
  data
end

#list_sandboxes_paginated(opts = {}) ⇒ PaginatedSandboxes

List all sandboxes paginated

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :page (Float) —

    Page number of the results (default to 1)

  • :limit (Float) —

    Number of results per page (default to 100)

  • :id (String) —

    Filter by partial ID match

  • :name (String) —

    Filter by partial name match

  • :labels (String) —

    JSON encoded labels to filter by

  • :include_errored_deleted (Boolean) —

    Include results with errored state and deleted desired state (default to false)

  • :states (Array<String>) —

    List of states to filter by

  • :snapshots (Array<String>) —

    List of snapshot names to filter by

  • :regions (Array<String>) —

    List of regions to filter by

  • :min_cpu (Float) —

    Minimum CPU

  • :max_cpu (Float) —

    Maximum CPU

  • :min_memory_gi_b (Float) —

    Minimum memory in GiB

  • :max_memory_gi_b (Float) —

    Maximum memory in GiB

  • :min_disk_gi_b (Float) —

    Minimum disk space in GiB

  • :max_disk_gi_b (Float) —

    Maximum disk space in GiB

  • :last_event_after (Time) —

    Include items with last event after this timestamp

  • :last_event_before (Time) —

    Include items with last event before this timestamp

  • :sort (String) —

    Field to sort by (default to ‘createdAt’)

  • :order (String) —

    Direction to sort by (default to ‘desc’)

Returns:



983
984
985
986
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 983

def list_sandboxes_paginated(opts = {})
  data, _status_code, _headers = list_sandboxes_paginated_with_http_info(opts)
  data
end

#list_sandboxes_paginated_with_http_info(opts = {}) ⇒ Array<(PaginatedSandboxes, Integer, Hash)>

List all sandboxes paginated

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :page (Float) —

    Page number of the results (default to 1)

  • :limit (Float) —

    Number of results per page (default to 100)

  • :id (String) —

    Filter by partial ID match

  • :name (String) —

    Filter by partial name match

  • :labels (String) —

    JSON encoded labels to filter by

  • :include_errored_deleted (Boolean) —

    Include results with errored state and deleted desired state (default to false)

  • :states (Array<String>) —

    List of states to filter by

  • :snapshots (Array<String>) —

    List of snapshot names to filter by

  • :regions (Array<String>) —

    List of regions to filter by

  • :min_cpu (Float) —

    Minimum CPU

  • :max_cpu (Float) —

    Maximum CPU

  • :min_memory_gi_b (Float) —

    Minimum memory in GiB

  • :max_memory_gi_b (Float) —

    Maximum memory in GiB

  • :min_disk_gi_b (Float) —

    Minimum disk space in GiB

  • :max_disk_gi_b (Float) —

    Maximum disk space in GiB

  • :last_event_after (Time) —

    Include items with last event after this timestamp

  • :last_event_before (Time) —

    Include items with last event before this timestamp

  • :sort (String) —

    Field to sort by (default to ‘createdAt’)

  • :order (String) —

    Direction to sort by (default to ‘desc’)

Returns:

  • (Array<(PaginatedSandboxes, Integer, Hash)>) —

    PaginatedSandboxes data, response status code and response headers



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1011

def list_sandboxes_paginated_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.list_sandboxes_paginated ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SandboxApi.list_sandboxes_paginated, must be smaller than or equal to 200.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  allowable_values = ["creating", "restoring", "destroying", "started", "stopped", "starting", "stopping", "error", "build_failed", "pending_build", "building_snapshot", "unknown", "pulling_snapshot", "archived", "archiving", "resizing"]
  if @api_client.config.client_side_validation && opts[:'states'] && !opts[:'states'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"states\", must include one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'min_cpu'].nil? && opts[:'min_cpu'] < 1
    fail ArgumentError, 'invalid value for "opts[:"min_cpu"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'max_cpu'].nil? && opts[:'max_cpu'] < 1
    fail ArgumentError, 'invalid value for "opts[:"max_cpu"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'min_memory_gi_b'].nil? && opts[:'min_memory_gi_b'] < 1
    fail ArgumentError, 'invalid value for "opts[:"min_memory_gi_b"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'max_memory_gi_b'].nil? && opts[:'max_memory_gi_b'] < 1
    fail ArgumentError, 'invalid value for "opts[:"max_memory_gi_b"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'min_disk_gi_b'].nil? && opts[:'min_disk_gi_b'] < 1
    fail ArgumentError, 'invalid value for "opts[:"min_disk_gi_b"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'max_disk_gi_b'].nil? && opts[:'max_disk_gi_b'] < 1
    fail ArgumentError, 'invalid value for "opts[:"max_disk_gi_b"]" when calling SandboxApi.list_sandboxes_paginated, must be greater than or equal to 1.'
  end

  allowable_values = ["id", "name", "state", "snapshot", "region", "updatedAt", "createdAt"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
    fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sandbox/paginated'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'labels'] = opts[:'labels'] if !opts[:'labels'].nil?
  query_params[:'includeErroredDeleted'] = opts[:'include_errored_deleted'] if !opts[:'include_errored_deleted'].nil?
  query_params[:'states'] = @api_client.build_collection_param(opts[:'states'], :multi) if !opts[:'states'].nil?
  query_params[:'snapshots'] = @api_client.build_collection_param(opts[:'snapshots'], :multi) if !opts[:'snapshots'].nil?
  query_params[:'regions'] = @api_client.build_collection_param(opts[:'regions'], :multi) if !opts[:'regions'].nil?
  query_params[:'minCpu'] = opts[:'min_cpu'] if !opts[:'min_cpu'].nil?
  query_params[:'maxCpu'] = opts[:'max_cpu'] if !opts[:'max_cpu'].nil?
  query_params[:'minMemoryGiB'] = opts[:'min_memory_gi_b'] if !opts[:'min_memory_gi_b'].nil?
  query_params[:'maxMemoryGiB'] = opts[:'max_memory_gi_b'] if !opts[:'max_memory_gi_b'].nil?
  query_params[:'minDiskGiB'] = opts[:'min_disk_gi_b'] if !opts[:'min_disk_gi_b'].nil?
  query_params[:'maxDiskGiB'] = opts[:'max_disk_gi_b'] if !opts[:'max_disk_gi_b'].nil?
  query_params[:'lastEventAfter'] = opts[:'last_event_after'] if !opts[:'last_event_after'].nil?
  query_params[:'lastEventBefore'] = opts[:'last_event_before'] if !opts[:'last_event_before'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedSandboxes'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.list_sandboxes_paginated",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#list_sandboxes_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_sandboxes_with_http_info(opts = {}) ⇒ Array<(Array<Sandbox>, Integer, Hash)>

List all sandboxes

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :verbose (Boolean) —

    Include verbose output

  • :labels (String) —

    JSON encoded labels to filter by

  • :include_errored_deleted (Boolean) —

    Include errored and deleted sandboxes

Returns:

  • (Array<(Array<Sandbox>, Integer, Hash)>) —

    Array<Sandbox> data, response status code and response headers



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 912

def list_sandboxes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.list_sandboxes ...'
  end
  # resource path
  local_var_path = '/sandbox'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'verbose'] = opts[:'verbose'] if !opts[:'verbose'].nil?
  query_params[:'labels'] = opts[:'labels'] if !opts[:'labels'].nil?
  query_params[:'includeErroredDeleted'] = opts[:'include_errored_deleted'] if !opts[:'include_errored_deleted'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Sandbox>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.list_sandboxes",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#list_sandboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recover_sandbox(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Recover sandbox from error state

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1128
1129
1130
1131
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1128

def recover_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = recover_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

#recover_sandbox_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Recover sandbox from error state

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1138

def recover_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.recover_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.recover_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/recover'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.recover_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#recover_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_labels(sandbox_id_or_name, sandbox_labels, opts = {}) ⇒ SandboxLabels

Replace sandbox labels

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • sandbox_labels (SandboxLabels)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1193
1194
1195
1196
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1193

def replace_labels(sandbox_id_or_name, sandbox_labels, opts = {})
  data, _status_code, _headers = replace_labels_with_http_info(sandbox_id_or_name, sandbox_labels, opts)
  data
end

#replace_labels_with_http_info(sandbox_id_or_name, sandbox_labels, opts = {}) ⇒ Array<(SandboxLabels, Integer, Hash)>

Replace sandbox labels

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • sandbox_labels (SandboxLabels)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(SandboxLabels, Integer, Hash)>) —

    SandboxLabels data, response status code and response headers



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1204

def replace_labels_with_http_info(sandbox_id_or_name, sandbox_labels, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.replace_labels ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.replace_labels"
  end
  # verify the required parameter 'sandbox_labels' is set
  if @api_client.config.client_side_validation && sandbox_labels.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_labels' when calling SandboxApi.replace_labels"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/labels'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_labels)

  # return_type
  return_type = opts[:debug_return_type] || 'SandboxLabels'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.replace_labels",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#replace_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#resize_sandbox(sandbox_id_or_name, resize_sandbox, opts = {}) ⇒ Sandbox

Resize sandbox resources

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • resize_sandbox (ResizeSandbox)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1268
1269
1270
1271
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1268

def resize_sandbox(sandbox_id_or_name, resize_sandbox, opts = {})
  data, _status_code, _headers = resize_sandbox_with_http_info(sandbox_id_or_name, resize_sandbox, opts)
  data
end

#resize_sandbox_with_http_info(sandbox_id_or_name, resize_sandbox, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Resize sandbox resources

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • resize_sandbox (ResizeSandbox)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1279

def resize_sandbox_with_http_info(sandbox_id_or_name, resize_sandbox, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.resize_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.resize_sandbox"
  end
  # verify the required parameter 'resize_sandbox' is set
  if @api_client.config.client_side_validation && resize_sandbox.nil?
    fail ArgumentError, "Missing the required parameter 'resize_sandbox' when calling SandboxApi.resize_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/resize'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(resize_sandbox)

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.resize_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#resize_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_ssh_access(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Revoke SSH access for sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :token (String) —

    SSH access token to revoke. If not provided, all SSH access for the sandbox will be revoked.

Returns:



1343
1344
1345
1346
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1343

def revoke_ssh_access(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = revoke_ssh_access_with_http_info(sandbox_id_or_name, opts)
  data
end

#revoke_ssh_access_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Revoke SSH access for sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :token (String) —

    SSH access token to revoke. If not provided, all SSH access for the sandbox will be revoked.

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1354

def revoke_ssh_access_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.revoke_ssh_access ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.revoke_ssh_access"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ssh-access'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.revoke_ssh_access",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#revoke_ssh_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_auto_archive_interval(sandbox_id_or_name, interval, opts = {}) ⇒ Sandbox

Set sandbox auto-archive interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-archive interval in minutes (0 means the maximum interval will be used)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1410
1411
1412
1413
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1410

def set_auto_archive_interval(sandbox_id_or_name, interval, opts = {})
  data, _status_code, _headers = set_auto_archive_interval_with_http_info(sandbox_id_or_name, interval, opts)
  data
end

#set_auto_archive_interval_with_http_info(sandbox_id_or_name, interval, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Set sandbox auto-archive interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-archive interval in minutes (0 means the maximum interval will be used)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1421

def set_auto_archive_interval_with_http_info(sandbox_id_or_name, interval, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.set_auto_archive_interval ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.set_auto_archive_interval"
  end
  # verify the required parameter 'interval' is set
  if @api_client.config.client_side_validation && interval.nil?
    fail ArgumentError, "Missing the required parameter 'interval' when calling SandboxApi.set_auto_archive_interval"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/autoarchive/{interval}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'interval' + '}', CGI.escape(interval.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.set_auto_archive_interval",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#set_auto_archive_interval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_auto_delete_interval(sandbox_id_or_name, interval, opts = {}) ⇒ Sandbox

Set sandbox auto-delete interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1480
1481
1482
1483
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1480

def set_auto_delete_interval(sandbox_id_or_name, interval, opts = {})
  data, _status_code, _headers = set_auto_delete_interval_with_http_info(sandbox_id_or_name, interval, opts)
  data
end

#set_auto_delete_interval_with_http_info(sandbox_id_or_name, interval, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Set sandbox auto-delete interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1491

def set_auto_delete_interval_with_http_info(sandbox_id_or_name, interval, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.set_auto_delete_interval ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.set_auto_delete_interval"
  end
  # verify the required parameter 'interval' is set
  if @api_client.config.client_side_validation && interval.nil?
    fail ArgumentError, "Missing the required parameter 'interval' when calling SandboxApi.set_auto_delete_interval"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/autodelete/{interval}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'interval' + '}', CGI.escape(interval.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.set_auto_delete_interval",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#set_auto_delete_interval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_autostop_interval(sandbox_id_or_name, interval, opts = {}) ⇒ Sandbox

Set sandbox auto-stop interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-stop interval in minutes (0 to disable)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1550
1551
1552
1553
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1550

def set_autostop_interval(sandbox_id_or_name, interval, opts = {})
  data, _status_code, _headers = set_autostop_interval_with_http_info(sandbox_id_or_name, interval, opts)
  data
end

#set_autostop_interval_with_http_info(sandbox_id_or_name, interval, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Set sandbox auto-stop interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-stop interval in minutes (0 to disable)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1561

def set_autostop_interval_with_http_info(sandbox_id_or_name, interval, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.set_autostop_interval ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.set_autostop_interval"
  end
  # verify the required parameter 'interval' is set
  if @api_client.config.client_side_validation && interval.nil?
    fail ArgumentError, "Missing the required parameter 'interval' when calling SandboxApi.set_autostop_interval"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/autostop/{interval}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'interval' + '}', CGI.escape(interval.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.set_autostop_interval",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#set_autostop_interval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start_sandbox(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Start sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1619
1620
1621
1622
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1619

def start_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = start_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

#start_sandbox_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Start sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1629

def start_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.start_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.start_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/start'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.start_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#start_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stop_sandbox(sandbox_id_or_name, opts = {}) ⇒ Sandbox

Stop sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1683
1684
1685
1686
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1683

def stop_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = stop_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

#stop_sandbox_with_http_info(sandbox_id_or_name, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Stop sandbox

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1693

def stop_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.stop_sandbox ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.stop_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/stop'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.stop_sandbox",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#stop_sandbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_last_activity(sandbox_id, opts = {}) ⇒ nil

Update sandbox last activity

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (nil) 


1747
1748
1749
1750
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1747

def update_last_activity(sandbox_id, opts = {})
  update_last_activity_with_http_info(sandbox_id, opts)
  nil
end

#update_last_activity_with_http_info(sandbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update sandbox last activity

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1757

def update_last_activity_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.update_last_activity ...'
  end
  # verify the required parameter 'sandbox_id' is set
  if @api_client.config.client_side_validation && sandbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id' when calling SandboxApi.update_last_activity"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/last-activity'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.update_last_activity",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#update_last_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_public_status(sandbox_id_or_name, is_public, opts = {}) ⇒ Sandbox

Update public status

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • is_public (Boolean) —

    Public status to set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1810
1811
1812
1813
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1810

def update_public_status(sandbox_id_or_name, is_public, opts = {})
  data, _status_code, _headers = update_public_status_with_http_info(sandbox_id_or_name, is_public, opts)
  data
end

#update_public_status_with_http_info(sandbox_id_or_name, is_public, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Update public status

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • is_public (Boolean) —

    Public status to set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(Sandbox, Integer, Hash)>) —

    Sandbox data, response status code and response headers



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1821

def update_public_status_with_http_info(sandbox_id_or_name, is_public, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.update_public_status ...'
  end
  # verify the required parameter 'sandbox_id_or_name' is set
  if @api_client.config.client_side_validation && sandbox_id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id_or_name' when calling SandboxApi.update_public_status"
  end
  # verify the required parameter 'is_public' is set
  if @api_client.config.client_side_validation && is_public.nil?
    fail ArgumentError, "Missing the required parameter 'is_public' when calling SandboxApi.update_public_status"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/public/{isPublic}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'isPublic' + '}', CGI.escape(is_public.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Sandbox'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.update_public_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#update_public_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sandbox_state(sandbox_id, update_sandbox_state_dto, opts = {}) ⇒ nil

Update sandbox state

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • update_sandbox_state_dto (UpdateSandboxStateDto)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (nil) 


1880
1881
1882
1883
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1880

def update_sandbox_state(sandbox_id, update_sandbox_state_dto, opts = {})
  update_sandbox_state_with_http_info(sandbox_id, update_sandbox_state_dto, opts)
  nil
end

#update_sandbox_state_with_http_info(sandbox_id, update_sandbox_state_dto, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update sandbox state

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • update_sandbox_state_dto (UpdateSandboxStateDto)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1891

def update_sandbox_state_with_http_info(sandbox_id, update_sandbox_state_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.update_sandbox_state ...'
  end
  # verify the required parameter 'sandbox_id' is set
  if @api_client.config.client_side_validation && sandbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id' when calling SandboxApi.update_sandbox_state"
  end
  # verify the required parameter 'update_sandbox_state_dto' is set
  if @api_client.config.client_side_validation && update_sandbox_state_dto.nil?
    fail ArgumentError, "Missing the required parameter 'update_sandbox_state_dto' when calling SandboxApi.update_sandbox_state"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/state'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_sandbox_state_dto)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.update_sandbox_state",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#update_sandbox_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_ssh_access(token, opts = {}) ⇒ SshAccessValidationDto

Validate SSH access for sandbox

Parameters:

  • token (String) —

    SSH access token to validate

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1952
1953
1954
1955
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1952

def validate_ssh_access(token, opts = {})
  data, _status_code, _headers = validate_ssh_access_with_http_info(token, opts)
  data
end

#validate_ssh_access_with_http_info(token, opts = {}) ⇒ Array<(SshAccessValidationDto, Integer, Hash)>

Validate SSH access for sandbox

Parameters:

  • token (String) —

    SSH access token to validate

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (Array<(SshAccessValidationDto, Integer, Hash)>) —

    SshAccessValidationDto data, response status code and response headers



1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1962

def validate_ssh_access_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.validate_ssh_access ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling SandboxApi.validate_ssh_access"
  end
  # resource path
  local_var_path = '/sandbox/ssh-access/validate'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'token'] = token

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SshAccessValidationDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

  new_options = opts.merge(
    :operation => :"SandboxApi.validate_ssh_access",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SandboxApi#validate_ssh_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end