Back to Daytona

Config

apps/docs/src/content/docs/en/ruby-sdk/config.mdx

0.190.03.4 KB
Original Source

Config

Main class for a new Daytona::Config object.

Constructors

new Config()

ruby
def initialize(api_key:, jwt_token:, api_url:, organization_id:, target:, otel_enabled:, _experimental:)

Initializes a new Daytona::Config object.

Parameters:

  • api_key String, nil - Daytona API key. Defaults to ENV['DAYTONA_API_KEY'].
  • jwt_token String, nil - Daytona JWT token. Defaults to ENV['DAYTONA_JWT_TOKEN'].
  • api_url String, nil - Daytona API URL. Defaults to ENV['DAYTONA_API_URL'] or Daytona::Config::API_URL.
  • organization_id String, nil - Daytona organization ID. Defaults to ENV['DAYTONA_ORGANIZATION_ID'].
  • target String, nil - Daytona target. Defaults to ENV['DAYTONA_TARGET'].
  • otel_enabled Boolean, nil - Enable OpenTelemetry tracing for SDK operations.
  • _experimental Hash, nil - Experimental configuration options.

Returns:

  • Config - a new instance of Config

Methods

api_key()

ruby
def api_key()

API key for authentication with the Daytona API

Returns:

  • String, nil - Daytona API key

api_key=()

ruby
def api_key=(value)

API key for authentication with the Daytona API

Returns:

  • String, nil - Daytona API key

jwt_token()

ruby
def jwt_token()

JWT token for authentication with the Daytona API

Returns:

  • String, nil - Daytona JWT token

jwt_token=()

ruby
def jwt_token=(value)

JWT token for authentication with the Daytona API

Returns:

  • String, nil - Daytona JWT token

api_url()

ruby
def api_url()

URL of the Daytona API

Returns:

  • String, nil - Daytona API URL

api_url=()

ruby
def api_url=(value)

URL of the Daytona API

Returns:

  • String, nil - Daytona API URL

organization_id()

ruby
def organization_id()

Organization ID for authentication with the Daytona API

Returns:

  • String, nil - Daytona API URL

organization_id=()

ruby
def organization_id=(value)

Organization ID for authentication with the Daytona API

Returns:

  • String, nil - Daytona API URL

target()

ruby
def target()

Target environment for sandboxes

Returns:

  • String, nil - Daytona target

target=()

ruby
def target=(value)

Target environment for sandboxes

Returns:

  • String, nil - Daytona target

otel_enabled()

ruby
def otel_enabled()

Enable OpenTelemetry tracing for SDK operations.

Returns:

  • Boolean, nil

otel_enabled=()

ruby
def otel_enabled=(value)

Enable OpenTelemetry tracing for SDK operations.

Returns:

  • Boolean, nil

_experimental()

ruby
def _experimental()

Experimental configuration options

Returns:

  • Hash, nil - Experimental configuration hash

_experimental=()

ruby
def _experimental=(value)

Experimental configuration options

Returns:

  • Hash, nil - Experimental configuration hash

read_env()

ruby
def read_env(name)

Reads a DAYTONA_-prefixed environment variable using the same precedence as the Config initializer: runtime ENV first, then .env.local, then .env. Only names starting with DAYTONA_ are accepted.

Parameters:

  • name String - The environment variable name. Must start with DAYTONA_.

Returns:

  • String, nil - The value of the environment variable, or nil if not set.

Raises:

  • ArgumentError - If name does not start with DAYTONA_.