ExDaytona.Api.Server (ex_daytona v0.4.0)

Copy Markdown View Source

API calls for all endpoints tagged Server.

Summary

Functions

Initialize toolbox server Set the auth token and initialize telemetry for the toolbox server

Update process environment Update the daemon's process environment. Newly spawned processes, sessions and PTYs inherit the change; already-running processes keep their environment.

Functions

initialize(connection, initialize_request, opts \\ [])

@spec initialize(Tesla.Env.client(), ExDaytona.Model.InitializeRequest.t(), keyword()) ::
  {:ok, %{optional(String.t()) => String.t()}} | {:error, Tesla.Env.t()}

Initialize toolbox server Set the auth token and initialize telemetry for the toolbox server

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • initialize_request (InitializeRequest): Initialization request
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

update_env(connection, update_env_request, opts \\ [])

@spec update_env(Tesla.Env.client(), ExDaytona.Model.UpdateEnvRequest.t(), keyword()) ::
  {:ok, %{optional(String.t()) => String.t()}} | {:error, Tesla.Env.t()}

Update process environment Update the daemon's process environment. Newly spawned processes, sessions and PTYs inherit the change; already-running processes keep their environment.

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • update_env_request (UpdateEnvRequest): Environment update request
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure