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 Deprecated: backups are managed automatically. This endpoint is a no-op kept for compatibility.

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:



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

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 Deprecated: backups are managed automatically. This endpoint is a no-op kept for compatibility.

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 103

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:



157
158
159
160
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 157

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

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

Create a snapshot from a sandbox

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



227
228
229
230
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 227

def create_sandbox_snapshot(sandbox_id_or_name, create_sandbox_snapshot, opts = {})
  data, _status_code, _headers = create_sandbox_snapshot_with_http_info(sandbox_id_or_name, create_sandbox_snapshot, opts)
  data
end

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

Create a snapshot from a sandbox

Parameters:

  • sandbox_id_or_name (String)
  • create_sandbox_snapshot (CreateSandboxSnapshot)
  • 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



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
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 238

def create_sandbox_snapshot_with_http_info(sandbox_id_or_name, create_sandbox_snapshot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.create_sandbox_snapshot ...'
  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_sandbox_snapshot"
  end
  # verify the required parameter 'create_sandbox_snapshot' is set
  if @api_client.config.client_side_validation && create_sandbox_snapshot.nil?
    fail ArgumentError, "Missing the required parameter 'create_sandbox_snapshot' when calling SandboxApi.create_sandbox_snapshot"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/snapshot'.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(create_sandbox_snapshot)

  # 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_snapshot",
    :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_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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



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

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:



302
303
304
305
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 302

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



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
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 313

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:



368
369
370
371
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 368

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



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

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) 


434
435
436
437
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 434

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



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
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 446

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

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

Fork a sandbox

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



507
508
509
510
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 507

def fork_sandbox(sandbox_id_or_name, fork_sandbox, opts = {})
  data, _status_code, _headers = fork_sandbox_with_http_info(sandbox_id_or_name, fork_sandbox, opts)
  data
end

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

Fork a sandbox

Parameters:

  • sandbox_id_or_name (String)
  • fork_sandbox (ForkSandbox)
  • 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



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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 518

def fork_sandbox_with_http_info(sandbox_id_or_name, fork_sandbox, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.fork_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.fork_sandbox"
  end
  # verify the required parameter 'fork_sandbox' is set
  if @api_client.config.client_side_validation && fork_sandbox.nil?
    fail ArgumentError, "Missing the required parameter 'fork_sandbox' when calling SandboxApi.fork_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/fork'.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(fork_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.fork_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#fork_sandbox\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) 


583
584
585
586
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 583

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:



648
649
650
651
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 648

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



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
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 658

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 `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:

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

    nil, response status code and response headers



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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 595

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_organization_by_sandbox_id(sandbox_id, opts = {}) ⇒ Organization

Get organization by sandbox ID

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:



712
713
714
715
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 712

def get_organization_by_sandbox_id(sandbox_id, opts = {})
  data, _status_code, _headers = get_organization_by_sandbox_id_with_http_info(sandbox_id, opts)
  data
end

#get_organization_by_sandbox_id_with_http_info(sandbox_id, opts = {}) ⇒ Array<(Organization, Integer, Hash)>

Get organization by sandbox ID

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<(Organization, Integer, Hash)>) —

    Organization data, response status code and response headers



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
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 722

def get_organization_by_sandbox_id_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_organization_by_sandbox_id ...'
  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_organization_by_sandbox_id"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/organization'.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] || 'Organization'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_organization_by_sandbox_id",
    :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_organization_by_sandbox_id\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:



777
778
779
780
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 777

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



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
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 788

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_region_quota_by_sandbox_id(sandbox_id, opts = {}) ⇒ RegionQuota

Get region quota by sandbox ID

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:



846
847
848
849
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 846

def get_region_quota_by_sandbox_id(sandbox_id, opts = {})
  data, _status_code, _headers = get_region_quota_by_sandbox_id_with_http_info(sandbox_id, opts)
  data
end

#get_region_quota_by_sandbox_id_with_http_info(sandbox_id, opts = {}) ⇒ Array<(RegionQuota, Integer, Hash)>

Get region quota by sandbox ID

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<(RegionQuota, Integer, Hash)>) —

    RegionQuota data, response status code and response headers



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
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 856

def get_region_quota_by_sandbox_id_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_region_quota_by_sandbox_id ...'
  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_region_quota_by_sandbox_id"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/region-quota'.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] || 'RegionQuota'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_region_quota_by_sandbox_id",
    :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_region_quota_by_sandbox_id\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 Sandboxes destroyed by spot preemption remain retrievable for 24 hours so spotEvictedAt can be read.

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:



912
913
914
915
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 912

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_ancestors(sandbox_id_or_name, opts = {}) ⇒ Array<Sandbox>

Get sandbox fork ancestor chain

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:



979
980
981
982
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 979

def get_sandbox_ancestors(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = get_sandbox_ancestors_with_http_info(sandbox_id_or_name, opts)
  data
end

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

Get sandbox fork ancestor chain

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<(Array<Sandbox>, Integer, Hash)>) —

    Array data, response status code and response headers



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
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
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 989

def get_sandbox_ancestors_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_ancestors ...'
  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_ancestors"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ancestors'.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] || 'Array<Sandbox>'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox_ancestors",
    :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_ancestors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox_forks(sandbox_id_or_name, opts = {}) ⇒ Array<Sandbox>

Get sandbox fork children

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

  • :include_destroyed (Boolean)

Returns:



1044
1045
1046
1047
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1044

def get_sandbox_forks(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = get_sandbox_forks_with_http_info(sandbox_id_or_name, opts)
  data
end

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

Get sandbox fork children

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

  • :include_destroyed (Boolean)

Returns:

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

    Array data, response status code and response headers



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

def get_sandbox_forks_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_forks ...'
  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_forks"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/forks'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeDestroyed'] = opts[:'include_destroyed'] if !opts[:'include_destroyed'].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_sandbox_forks",
    :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_forks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox_logs(sandbox_id, from, to, opts = {}) ⇒ PaginatedLogs

Get sandbox logs Retrieve OTEL logs for a sandbox within a time range

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • from (Time) —

    Start of time range (ISO 8601)

  • to (Time) —

    End of time range (ISO 8601)

  • 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 (1-indexed) (default to 1)

  • :limit (Float) —

    Number of items per page (default to 100)

  • :severities (Array<String>) —

    Filter by severity levels (DEBUG, INFO, WARN, ERROR)

  • :search (String) —

    Search in log body

Returns:



1117
1118
1119
1120
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1117

def get_sandbox_logs(sandbox_id, from, to, opts = {})
  data, _status_code, _headers = get_sandbox_logs_with_http_info(sandbox_id, from, to, opts)
  data
end

#get_sandbox_logs_with_http_info(sandbox_id, from, to, opts = {}) ⇒ Array<(PaginatedLogs, Integer, Hash)>

Get sandbox logs Retrieve OTEL logs for a sandbox within a time range

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • from (Time) —

    Start of time range (ISO 8601)

  • to (Time) —

    End of time range (ISO 8601)

  • 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 (1-indexed) (default to 1)

  • :limit (Float) —

    Number of items per page (default to 100)

  • :severities (Array<String>) —

    Filter by severity levels (DEBUG, INFO, WARN, ERROR)

  • :search (String) —

    Search in log body

Returns:

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

    PaginatedLogs data, response status code and response headers



1134
1135
1136
1137
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
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1134

def get_sandbox_logs_with_http_info(sandbox_id, from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_logs ...'
  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_sandbox_logs"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling SandboxApi.get_sandbox_logs"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling SandboxApi.get_sandbox_logs"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/telemetry/logs'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'severities'] = @api_client.build_collection_param(opts[:'severities'], :multi) if !opts[:'severities'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].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] || 'PaginatedLogs'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox_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_sandbox_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox_metrics(sandbox_id, from, to, opts = {}) ⇒ MetricsResponse

Get sandbox metrics Retrieve OTEL metrics for a sandbox within a time range

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • from (Time) —

    Start of time range (ISO 8601)

  • to (Time) —

    End of time range (ISO 8601)

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :metric_names (Array<String>) —

    Filter by metric names

Returns:



1206
1207
1208
1209
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1206

def get_sandbox_metrics(sandbox_id, from, to, opts = {})
  data, _status_code, _headers = get_sandbox_metrics_with_http_info(sandbox_id, from, to, opts)
  data
end

#get_sandbox_metrics_with_http_info(sandbox_id, from, to, opts = {}) ⇒ Array<(MetricsResponse, Integer, Hash)>

Get sandbox metrics Retrieve OTEL metrics for a sandbox within a time range

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • from (Time) —

    Start of time range (ISO 8601)

  • to (Time) —

    End of time range (ISO 8601)

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :metric_names (Array<String>) —

    Filter by metric names

Returns:

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

    MetricsResponse data, response status code and response headers



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
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1220

def get_sandbox_metrics_with_http_info(sandbox_id, from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_metrics ...'
  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_sandbox_metrics"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling SandboxApi.get_sandbox_metrics"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling SandboxApi.get_sandbox_metrics"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/telemetry/metrics'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'metricNames'] = @api_client.build_collection_param(opts[:'metric_names'], :multi) if !opts[:'metric_names'].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] || 'MetricsResponse'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox_metrics",
    :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_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get sandbox fork parent

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:



1285
1286
1287
1288
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1285

def get_sandbox_parent(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = get_sandbox_parent_with_http_info(sandbox_id_or_name, opts)
  data
end

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

Get sandbox fork parent

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



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
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1295

def get_sandbox_parent_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_parent ...'
  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_parent"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/parent'.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.get_sandbox_parent",
    :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_parent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox_signing_key(sandbox_id, opts = {}) ⇒ String

Get the signing key 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:

  • (String) 


1349
1350
1351
1352
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1349

def get_sandbox_signing_key(sandbox_id, opts = {})
  data, _status_code, _headers = get_sandbox_signing_key_with_http_info(sandbox_id, opts)
  data
end

#get_sandbox_signing_key_with_http_info(sandbox_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get the signing key 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<(String, Integer, Hash)>) —

    String data, response status code and response headers



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
1403
1404
1405
1406
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1359

def get_sandbox_signing_key_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_signing_key ...'
  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_sandbox_signing_key"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/signing-key'.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] || 'String'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox_signing_key",
    :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_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox_trace_spans(sandbox_id, trace_id, opts = {}) ⇒ Array<TraceSpan>

Get trace spans Retrieve all spans for a specific trace

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • trace_id (String) —

    ID of the trace

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



1415
1416
1417
1418
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1415

def get_sandbox_trace_spans(sandbox_id, trace_id, opts = {})
  data, _status_code, _headers = get_sandbox_trace_spans_with_http_info(sandbox_id, trace_id, opts)
  data
end

#get_sandbox_trace_spans_with_http_info(sandbox_id, trace_id, opts = {}) ⇒ Array<(Array<TraceSpan>, Integer, Hash)>

Get trace spans Retrieve all spans for a specific trace

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • trace_id (String) —

    ID of the trace

  • 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<(Array<TraceSpan>, Integer, Hash)>) —

    Array data, response status code and response headers



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
1473
1474
1475
1476
1477
1478
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1427

def get_sandbox_trace_spans_with_http_info(sandbox_id, trace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_trace_spans ...'
  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_sandbox_trace_spans"
  end
  # verify the required parameter 'trace_id' is set
  if @api_client.config.client_side_validation && trace_id.nil?
    fail ArgumentError, "Missing the required parameter 'trace_id' when calling SandboxApi.get_sandbox_trace_spans"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/telemetry/traces/{traceId}'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s)).sub('{' + 'traceId' + '}', CGI.escape(trace_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] || 'Array<TraceSpan>'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox_trace_spans",
    :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_trace_spans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sandbox_traces(sandbox_id, from, to, opts = {}) ⇒ PaginatedTraces

Get sandbox traces Retrieve OTEL traces for a sandbox within a time range

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • from (Time) —

    Start of time range (ISO 8601)

  • to (Time) —

    End of time range (ISO 8601)

  • 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 (1-indexed) (default to 1)

  • :limit (Float) —

    Number of items per page (default to 100)

Returns:



1490
1491
1492
1493
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1490

def get_sandbox_traces(sandbox_id, from, to, opts = {})
  data, _status_code, _headers = get_sandbox_traces_with_http_info(sandbox_id, from, to, opts)
  data
end

#get_sandbox_traces_with_http_info(sandbox_id, from, to, opts = {}) ⇒ Array<(PaginatedTraces, Integer, Hash)>

Get sandbox traces Retrieve OTEL traces for a sandbox within a time range

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

  • from (Time) —

    Start of time range (ISO 8601)

  • to (Time) —

    End of time range (ISO 8601)

  • 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 (1-indexed) (default to 1)

  • :limit (Float) —

    Number of items per page (default to 100)

Returns:

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

    PaginatedTraces data, response status code and response headers



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
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1505

def get_sandbox_traces_with_http_info(sandbox_id, from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_traces ...'
  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_sandbox_traces"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling SandboxApi.get_sandbox_traces"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling SandboxApi.get_sandbox_traces"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/telemetry/traces'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'PaginatedTraces'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.get_sandbox_traces",
    :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_traces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get sandbox details Sandboxes destroyed by spot preemption remain retrievable for 24 hours so `spotEvictedAt` can be read.

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



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
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 924

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:



1572
1573
1574
1575
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1572

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 data, response status code and response headers



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
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1583

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:



1637
1638
1639
1640
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1637

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



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
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1649

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:



1708
1709
1710
1711
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1708

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



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1718

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 = {}) ⇒ ListSandboxesResponse

List sandboxes Advanced filtering and ordering. Eventually consistent.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :cursor (String) —

    Pagination cursor from a previous response

  • :limit (Float) —

    Number of results per page (default to 100)

  • :id (String) —

    Filter by ID prefix (case-insensitive)

  • :name (String) —

    Filter by name prefix (case-insensitive)

  • :labels (String) —

    JSON encoded labels to filter by

  • :include_errored_deleted (Boolean) —

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

  • :include_warm (Boolean) —

    Include unclaimed warm pool sandboxes (excluded by default) (default to false)

  • :states (Array<SandboxState>) —

    List of states to filter by.

  • :snapshots (Array<String>) —

    List of snapshot names to filter by

  • :region_ids (Array<String>) —

    List of regions IDs to filter by

  • :sandbox_classes (Array<SandboxClass>) —

    List of sandbox classes 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

  • :is_public (Boolean) —

    Filter by public status

  • :is_recoverable (Boolean) —

    Filter by recoverable status

  • :created_at_after (Time) —

    Include items created after this timestamp

  • :created_at_before (Time) —

    Include items created before this timestamp

  • :last_event_after (Time) —

    Include items with last event after this timestamp

  • :last_event_before (Time) —

    Include items with last event before this timestamp

  • :auto_destroy_at_after (Time) —

    Include items scheduled for auto destroy after this timestamp

  • :auto_destroy_at_before (Time) —

    Include items scheduled for auto destroy before this timestamp

  • :sort (SandboxListSortField) —

    Field to sort by

  • :order (SandboxListSortDirection) —

    Direction to sort by

Returns:



1799
1800
1801
1802
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1799

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

#list_sandboxes_paginated_deprecated(opts = {}) ⇒ PaginatedSandboxesDeprecated

[DEPRECATED] 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:



1963
1964
1965
1966
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1963

def list_sandboxes_paginated_deprecated(opts = {})
  data, _status_code, _headers = list_sandboxes_paginated_deprecated_with_http_info(opts)
  data
end

#list_sandboxes_paginated_deprecated_with_http_info(opts = {}) ⇒ Array<(PaginatedSandboxesDeprecated, Integer, Hash)>

[DEPRECATED] 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:



1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1991

def list_sandboxes_paginated_deprecated_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.list_sandboxes_paginated_deprecated ...'
  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_deprecated, 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_deprecated, 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_deprecated, 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", "snapshotting", "forking", "pausing", "paused", "resuming", "unknown_default_open_api"]
  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_deprecated, 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_deprecated, 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_deprecated, 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_deprecated, 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_deprecated, 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_deprecated, must be greater than or equal to 1.'
  end

  allowable_values = ["id", "name", "state", "snapshot", "region", "updatedAt", "createdAt", "lastActivityAt", "unknown_default_open_api"]
  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", "unknown_default_open_api"]
  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] || 'PaginatedSandboxesDeprecated'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.list_sandboxes_paginated_deprecated",
    :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_deprecated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List sandboxes Advanced filtering and ordering. Eventually consistent.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

  • :cursor (String) —

    Pagination cursor from a previous response

  • :limit (Float) —

    Number of results per page (default to 100)

  • :id (String) —

    Filter by ID prefix (case-insensitive)

  • :name (String) —

    Filter by name prefix (case-insensitive)

  • :labels (String) —

    JSON encoded labels to filter by

  • :include_errored_deleted (Boolean) —

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

  • :include_warm (Boolean) —

    Include unclaimed warm pool sandboxes (excluded by default) (default to false)

  • :states (Array<SandboxState>) —

    List of states to filter by.

  • :snapshots (Array<String>) —

    List of snapshot names to filter by

  • :region_ids (Array<String>) —

    List of regions IDs to filter by

  • :sandbox_classes (Array<SandboxClass>) —

    List of sandbox classes 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

  • :is_public (Boolean) —

    Filter by public status

  • :is_recoverable (Boolean) —

    Filter by recoverable status

  • :created_at_after (Time) —

    Include items created after this timestamp

  • :created_at_before (Time) —

    Include items created before this timestamp

  • :last_event_after (Time) —

    Include items with last event after this timestamp

  • :last_event_before (Time) —

    Include items with last event before this timestamp

  • :auto_destroy_at_after (Time) —

    Include items scheduled for auto destroy after this timestamp

  • :auto_destroy_at_before (Time) —

    Include items scheduled for auto destroy before this timestamp

  • :sort (SandboxListSortField) —

    Field to sort by

  • :order (SandboxListSortDirection) —

    Direction to sort by

Returns:

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

    ListSandboxesResponse data, response status code and response headers



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
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
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
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 1836

def list_sandboxes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.list_sandboxes ...'
  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, 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, must be greater than or equal to 1.'
  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, 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, 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, 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, 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, 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, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/sandbox'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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[:'includeWarm'] = opts[:'include_warm'] if !opts[:'include_warm'].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[:'regionIds'] = @api_client.build_collection_param(opts[:'region_ids'], :multi) if !opts[:'region_ids'].nil?
  query_params[:'sandboxClasses'] = @api_client.build_collection_param(opts[:'sandbox_classes'], :multi) if !opts[:'sandbox_classes'].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[:'isPublic'] = opts[:'is_public'] if !opts[:'is_public'].nil?
  query_params[:'isRecoverable'] = opts[:'is_recoverable'] if !opts[:'is_recoverable'].nil?
  query_params[:'createdAtAfter'] = opts[:'created_at_after'] if !opts[:'created_at_after'].nil?
  query_params[:'createdAtBefore'] = opts[:'created_at_before'] if !opts[:'created_at_before'].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[:'autoDestroyAtAfter'] = opts[:'auto_destroy_at_after'] if !opts[:'auto_destroy_at_after'].nil?
  query_params[:'autoDestroyAtBefore'] = opts[:'auto_destroy_at_before'] if !opts[:'auto_destroy_at_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] || 'ListSandboxesResponse'

  # 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

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

Pause 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:



2108
2109
2110
2111
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2108

def pause_sandbox(sandbox_id_or_name, opts = {})
  data, _status_code, _headers = pause_sandbox_with_http_info(sandbox_id_or_name, opts)
  data
end

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

Pause 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



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2118

def pause_sandbox_with_http_info(sandbox_id_or_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.pause_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.pause_sandbox"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/pause'.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.pause_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#pause_sandbox\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

  • :skip_start (Boolean) —

    If true, the sandbox is left in STOPPED after recovery instead of being started.

Returns:



2173
2174
2175
2176
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2173

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

  • :skip_start (Boolean) —

    If true, the sandbox is left in STOPPED after recovery instead of being started.

Returns:

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

    Sandbox data, response status code and response headers



2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2184

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] || {}
  query_params[:'skipStart'] = opts[:'skip_start'] if !opts[:'skip_start'].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.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:



2240
2241
2242
2243
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2240

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



2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2251

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:



2315
2316
2317
2318
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2315

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



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2326

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

#resolve_sandbox_secrets(sandbox_id, opts = {}) ⇒ Array<ResolveSandboxSecrets200ResponseInner>

Resolve sandbox secrets

Parameters:

  • sandbox_id (String) —

    Sandbox ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



2389
2390
2391
2392
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2389

def resolve_sandbox_secrets(sandbox_id, opts = {})
  data, _status_code, _headers = resolve_sandbox_secrets_with_http_info(sandbox_id, opts)
  data
end

#resolve_sandbox_secrets_with_http_info(sandbox_id, opts = {}) ⇒ Array<(Array<ResolveSandboxSecrets200ResponseInner>, Integer, Hash)>

Resolve sandbox secrets

Parameters:

  • sandbox_id (String) —

    Sandbox ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2399

def resolve_sandbox_secrets_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.resolve_sandbox_secrets ...'
  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.resolve_sandbox_secrets"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/secrets'.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] || 'Array<ResolveSandboxSecrets200ResponseInner>'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.resolve_sandbox_secrets",
    :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#resolve_sandbox_secrets\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:



2454
2455
2456
2457
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2454

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



2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2465

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

#rotate_signing_key(sandbox_id, opts = {}) ⇒ String

Rotate the signing key, invalidating all previously signed URLs

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:

  • (String) 


2520
2521
2522
2523
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2520

def rotate_signing_key(sandbox_id, opts = {})
  data, _status_code, _headers = rotate_signing_key_with_http_info(sandbox_id, opts)
  data
end

#rotate_signing_key_with_http_info(sandbox_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Rotate the signing key, invalidating all previously signed URLs

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<(String, Integer, Hash)>) —

    String data, response status code and response headers



2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2530

def rotate_signing_key_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.rotate_signing_key ...'
  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.rotate_signing_key"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxId}/signing-key/rotate'.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] || 'String'

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

  new_options = opts.merge(
    :operation => :"SandboxApi.rotate_signing_key",
    :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#rotate_signing_key\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:



2585
2586
2587
2588
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2585

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



2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2596

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:



2655
2656
2657
2658
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2655

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



2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2666

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_auto_pause_interval(sandbox_id_or_name, interval, opts = {}) ⇒ Sandbox

Set sandbox auto-pause interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-pause 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:



2725
2726
2727
2728
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2725

def set_auto_pause_interval(sandbox_id_or_name, interval, opts = {})
  data, _status_code, _headers = set_auto_pause_interval_with_http_info(sandbox_id_or_name, interval, opts)
  data
end

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

Set sandbox auto-pause interval

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • interval (Float) —

    Auto-pause 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



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2736

def set_auto_pause_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_pause_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_pause_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_pause_interval"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/autopause/{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_pause_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_pause_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:



2795
2796
2797
2798
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2795

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



2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2806

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

#set_ttl(sandbox_id_or_name, ttl_minutes, opts = {}) ⇒ Sandbox

Set sandbox TTL

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • ttl_minutes (Float) —

    Maximum time to live in minutes, re-anchored from the current time (0 to disable). When it elapses the sandbox is destroyed, even if it is stopped, paused, or archived

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



2865
2866
2867
2868
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2865

def set_ttl(sandbox_id_or_name, ttl_minutes, opts = {})
  data, _status_code, _headers = set_ttl_with_http_info(sandbox_id_or_name, ttl_minutes, opts)
  data
end

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

Set sandbox TTL

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • ttl_minutes (Float) —

    Maximum time to live in minutes, re-anchored from the current time (0 to disable). When it elapses the sandbox is destroyed, even if it is stopped, paused, or archived

  • 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



2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2876

def set_ttl_with_http_info(sandbox_id_or_name, ttl_minutes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.set_ttl ...'
  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_ttl"
  end
  # verify the required parameter 'ttl_minutes' is set
  if @api_client.config.client_side_validation && ttl_minutes.nil?
    fail ArgumentError, "Missing the required parameter 'ttl_minutes' when calling SandboxApi.set_ttl"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/ttl/{ttlMinutes}'.sub('{' + 'sandboxIdOrName' + '}', CGI.escape(sandbox_id_or_name.to_s)).sub('{' + 'ttlMinutes' + '}', CGI.escape(ttl_minutes.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_ttl",
    :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_ttl\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 or resume sandbox Starts a stopped or archived sandbox, or resumes a paused sandbox. The transition taken depends on the current sandbox 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:



2935
2936
2937
2938
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2935

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 or resume sandbox Starts a stopped or archived sandbox, or resumes a paused sandbox. The transition taken depends on the current sandbox 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



2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 2946

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

  • :force (Boolean) —

    Force stop the sandbox using SIGKILL instead of SIGTERM

Returns:



3001
3002
3003
3004
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3001

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

  • :force (Boolean) —

    Force stop the sandbox using SIGKILL instead of SIGTERM

Returns:

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

    Sandbox data, response status code and response headers



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3012

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] || {}
  query_params[:'force'] = opts[:'force'] if !opts[:'force'].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.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

  • :update_last_activity (UpdateLastActivity)

Returns:

  • (nil) 


3068
3069
3070
3071
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3068

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

  • :update_last_activity (UpdateLastActivity)

Returns:

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

    nil, response status code and response headers



3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3079

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] || {}
  # 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(opts[:'update_last_activity'])

  # 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_network_settings(sandbox_id_or_name, update_sandbox_network_settings, opts = {}) ⇒ Sandbox

Update sandbox network settings Changes outbound network policy on the runner for a running sandbox (for example block all traffic, restore access, or set a CIDR allow list).

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



3138
3139
3140
3141
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3138

def update_network_settings(sandbox_id_or_name, update_sandbox_network_settings, opts = {})
  data, _status_code, _headers = update_network_settings_with_http_info(sandbox_id_or_name, update_sandbox_network_settings, opts)
  data
end

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

Update sandbox network settings Changes outbound network policy on the runner for a running sandbox (for example block all traffic, restore access, or set a CIDR allow list).

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • update_sandbox_network_settings (UpdateSandboxNetworkSettings)
  • 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



3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3150

def update_network_settings_with_http_info(sandbox_id_or_name, update_sandbox_network_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.update_network_settings ...'
  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_network_settings"
  end
  # verify the required parameter 'update_sandbox_network_settings' is set
  if @api_client.config.client_side_validation && update_sandbox_network_settings.nil?
    fail ArgumentError, "Missing the required parameter 'update_sandbox_network_settings' when calling SandboxApi.update_network_settings"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/network-settings'.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(update_sandbox_network_settings)

  # 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_network_settings",
    :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_network_settings\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:



3214
3215
3216
3217
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3214

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



3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3225

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_secrets(sandbox_id_or_name, update_sandbox_secrets, opts = {}) ⇒ Sandbox

Update sandbox secrets Replaces the set of vault secrets mounted in the sandbox. Attached, detached and rotated secrets take effect for outbound requests within seconds. New env vars become visible to processes spawned after the update; a sandbox created without any secrets must be restarted for newly attached secrets to work.

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



3285
3286
3287
3288
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3285

def update_sandbox_secrets(sandbox_id_or_name, update_sandbox_secrets, opts = {})
  data, _status_code, _headers = update_sandbox_secrets_with_http_info(sandbox_id_or_name, update_sandbox_secrets, opts)
  data
end

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

Update sandbox secrets Replaces the set of vault secrets mounted in the sandbox. Attached, detached and rotated secrets take effect for outbound requests within seconds. New env vars become visible to processes spawned after the update; a sandbox created without any secrets must be restarted for newly attached secrets to work.

Parameters:

  • sandbox_id_or_name (String) —

    ID or name of the sandbox

  • update_sandbox_secrets (UpdateSandboxSecrets)
  • 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



3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3297

def update_sandbox_secrets_with_http_info(sandbox_id_or_name, update_sandbox_secrets, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SandboxApi.update_sandbox_secrets ...'
  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_sandbox_secrets"
  end
  # verify the required parameter 'update_sandbox_secrets' is set
  if @api_client.config.client_side_validation && update_sandbox_secrets.nil?
    fail ArgumentError, "Missing the required parameter 'update_sandbox_secrets' when calling SandboxApi.update_sandbox_secrets"
  end
  # resource path
  local_var_path = '/sandbox/{sandboxIdOrName}/secrets'.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(update_sandbox_secrets)

  # 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_sandbox_secrets",
    :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_secrets\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) 


3361
3362
3363
3364
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3361

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



3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3372

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:



3433
3434
3435
3436
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3433

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



3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
 
# File 'lib/daytona_api_client/api/sandbox_api.rb', line 3443

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