ExDaytona.Api.Admin (ex_daytona v0.4.0)

Copy Markdown View Source

API calls for all endpoints tagged Admin.

Summary

Functions

admin_can_cleanup_image(connection, image_name, opts \\ [])

Check if an image can be cleaned up

admin_create_organization(connection, admin_create_organization, opts \\ [])

Create organization for user

admin_create_organization_region_quota(connection, organization_id, region_id, create_organization_region_quota, opts \\ [])

Create organization region quota

admin_create_runner(connection, admin_create_runner, opts \\ [])

Create runner

admin_create_user(connection, create_user, opts \\ [])

Create user

admin_delete_organization_region_quota(connection, organization_id, region_id, sandbox_class, opts \\ [])

Delete organization region quota

admin_delete_runner(connection, id, opts \\ [])

Delete runner

admin_get_all_audit_logs(connection, opts \\ [])

Get all audit logs

admin_get_message_attempts(connection, organization_id, message_id, opts \\ [])

Get delivery attempts for a webhook message

admin_get_organization_region_quota(connection, organization_id, region_id, sandbox_class, opts \\ [])

Get organization region quota

admin_get_runner_by_id(connection, id, opts \\ [])

Get runner by ID

admin_get_user(connection, id, opts \\ [])

Get user by ID

admin_get_webhook_status(connection, opts \\ [])

Get webhook service status

admin_initialize_webhooks(connection, organization_id, opts \\ [])

Initialize webhooks for an organization

admin_list_runners(connection, opts \\ [])

List all runners

admin_list_users(connection, opts \\ [])

List all users

admin_recover_sandbox(connection, sandbox_id, opts \\ [])

Recover sandbox from error state as an admin

admin_regenerate_key_pair(connection, id, opts \\ [])

Regenerate user key pair

admin_send_webhook(connection, organization_id, send_webhook_dto, opts \\ [])

Send a webhook message to an organization

admin_set_default_registry(connection, id, opts \\ [])

Set default registry

admin_set_snapshot_general_status(connection, id, set_snapshot_general_status_dto, opts \\ [])

Set snapshot general status

admin_update_organization_preview_warning(connection, organization_id, organization_preview_warning, opts \\ [])

Update organization preview warning

admin_update_organization_region_quota(connection, organization_id, region_id, update_organization_region_quota, opts \\ [])

Update organization region quota

admin_update_runner_scheduling(connection, id, opts \\ [])

Update runner scheduling status

Functions

admin_can_cleanup_image(connection, image_name, opts \\ [])

@spec admin_can_cleanup_image(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, boolean()} | {:error, Tesla.Env.t()}

Check if an image can be cleaned up

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • image_name (String.t): Image name with tag to check
  • opts (keyword): Optional parameters

Returns

  • {:ok, boolean()} on success
  • {:error, Tesla.Env.t} on failure

admin_create_organization(connection, admin_create_organization, opts \\ [])

@spec admin_create_organization(
  Tesla.Env.client(),
  ExDaytona.Model.AdminCreateOrganization.t(),
  keyword()
) :: {:ok, ExDaytona.Model.Organization.t()} | {:error, Tesla.Env.t()}

Create organization for user

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • admin_create_organization (AdminCreateOrganization):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.Organization.t} on success
  • {:error, Tesla.Env.t} on failure

admin_create_organization_region_quota(connection, organization_id, region_id, create_organization_region_quota, opts \\ [])

@spec admin_create_organization_region_quota(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  ExDaytona.Model.CreateOrganizationRegionQuota.t(),
  keyword()
) :: {:ok, ExDaytona.Model.RegionQuota.t()} | {:error, Tesla.Env.t()}

Create organization region quota

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t): Organization ID
  • region_id (String.t): ID of the region the new quota applies to
  • create_organization_region_quota (CreateOrganizationRegionQuota):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.RegionQuota.t} on success
  • {:error, Tesla.Env.t} on failure

admin_create_runner(connection, admin_create_runner, opts \\ [])

@spec admin_create_runner(
  Tesla.Env.client(),
  ExDaytona.Model.AdminCreateRunner.t(),
  keyword()
) ::
  {:ok, ExDaytona.Model.CreateRunnerResponse.t()} | {:error, Tesla.Env.t()}

Create runner

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • admin_create_runner (AdminCreateRunner):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.CreateRunnerResponse.t} on success
  • {:error, Tesla.Env.t} on failure

admin_create_user(connection, create_user, opts \\ [])

@spec admin_create_user(Tesla.Env.client(), ExDaytona.Model.CreateUser.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Create user

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • create_user (CreateUser):
  • opts (keyword): Optional parameters

Returns

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

admin_delete_organization_region_quota(connection, organization_id, region_id, sandbox_class, opts \\ [])

@spec admin_delete_organization_region_quota(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  ExDaytona.Model.SandboxClass.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete organization region quota

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t): Organization ID
  • region_id (String.t): Region ID
  • sandbox_class (SandboxClass): Sandbox class
  • opts (keyword): Optional parameters

Returns

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

admin_delete_runner(connection, id, opts \\ [])

@spec admin_delete_runner(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete runner

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t): Runner ID
  • opts (keyword): Optional parameters
    • :force (boolean()): Delete the runner without waiting for sandboxes already marked for destruction. Requires the runner to have stopped reporting as ready.

Returns

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

admin_get_all_audit_logs(connection, opts \\ [])

@spec admin_get_all_audit_logs(
  Tesla.Env.client(),
  keyword()
) :: {:ok, ExDaytona.Model.PaginatedAuditLogs.t()} | {:error, Tesla.Env.t()}

Get all audit logs

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :page (number()): Page number of the results
    • :limit (number()): Number of results per page
    • :from (DateTime.t): Deprecated alias for createdAt[gte]. From date (ISO 8601 format).
    • :to (DateTime.t): Deprecated alias for createdAt[lte]. To date (ISO 8601 format).
    • :nextToken (String.t): Token for cursor-based pagination. When provided, takes precedence over page parameter.
    • :id (StringFilter): Filter by audit log ID.
    • :actorId (StringFilter): Filter by actor user ID.
    • :actorEmail (StringFilter): Filter by actor email.
    • :actorApiKeyPrefix (StringFilter): Filter by actor API key prefix.
    • :actorApiKeySuffix (StringFilter): Filter by actor API key suffix.
    • :action (StringFilter): Filter by action.
    • :targetType (StringFilter): Filter by target type.
    • :targetId (StringFilter): Filter by target ID.
    • :statusCode (IntFilter): Filter by HTTP status code.
    • :createdAt (DateFilter): Filter by creation timestamp.

Returns

  • {:ok, ExDaytona.Model.PaginatedAuditLogs.t} on success
  • {:error, Tesla.Env.t} on failure

admin_get_message_attempts(connection, organization_id, message_id, opts \\ [])

@spec admin_get_message_attempts(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, [map()]} | {:error, Tesla.Env.t()}

Get delivery attempts for a webhook message

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t):
  • message_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%map(){}, ...]} on success
  • {:error, Tesla.Env.t} on failure

admin_get_organization_region_quota(connection, organization_id, region_id, sandbox_class, opts \\ [])

@spec admin_get_organization_region_quota(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  ExDaytona.Model.SandboxClass.t(),
  keyword()
) :: {:ok, ExDaytona.Model.RegionQuota.t()} | {:error, Tesla.Env.t()}

Get organization region quota

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t): Organization ID
  • region_id (String.t): Region ID
  • sandbox_class (SandboxClass): Sandbox class
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.RegionQuota.t} on success
  • {:error, Tesla.Env.t} on failure

admin_get_runner_by_id(connection, id, opts \\ [])

@spec admin_get_runner_by_id(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.RunnerFull.t()} | {:error, Tesla.Env.t()}

Get runner by ID

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t): Runner ID
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.RunnerFull.t} on success
  • {:error, Tesla.Env.t} on failure

admin_get_user(connection, id, opts \\ [])

@spec admin_get_user(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.User.t()} | {:error, Tesla.Env.t()}

Get user by ID

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.User.t} on success
  • {:error, Tesla.Env.t} on failure

admin_get_webhook_status(connection, opts \\ [])

@spec admin_get_webhook_status(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExDaytona.Model.AdminGetWebhookStatus200Response.t()}
  | {:error, Tesla.Env.t()}

Get webhook service status

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.AdminGetWebhookStatus200Response.t} on success
  • {:error, Tesla.Env.t} on failure

admin_initialize_webhooks(connection, organization_id, opts \\ [])

@spec admin_initialize_webhooks(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Initialize webhooks for an organization

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t):
  • opts (keyword): Optional parameters

Returns

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

admin_list_runners(connection, opts \\ [])

@spec admin_list_runners(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [ExDaytona.Model.RunnerFull.t()]} | {:error, Tesla.Env.t()}

List all runners

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :regionId (String.t): Filter runners by region ID

Returns

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

admin_list_users(connection, opts \\ [])

@spec admin_list_users(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

List all users

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

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

admin_recover_sandbox(connection, sandbox_id, opts \\ [])

@spec admin_recover_sandbox(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.Sandbox.t()} | {:error, Tesla.Env.t()}

Recover sandbox from error state as an admin

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • sandbox_id (String.t): ID of the sandbox
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.Sandbox.t} on success
  • {:error, Tesla.Env.t} on failure

admin_regenerate_key_pair(connection, id, opts \\ [])

@spec admin_regenerate_key_pair(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Regenerate user key pair

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

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

admin_send_webhook(connection, organization_id, send_webhook_dto, opts \\ [])

@spec admin_send_webhook(
  Tesla.Env.client(),
  String.t(),
  ExDaytona.Model.SendWebhookDto.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Send a webhook message to an organization

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t):
  • send_webhook_dto (SendWebhookDto):
  • opts (keyword): Optional parameters

Returns

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

admin_set_default_registry(connection, id, opts \\ [])

@spec admin_set_default_registry(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.DockerRegistry.t()} | {:error, Tesla.Env.t()}

Set default registry

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t): ID of the docker registry
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.DockerRegistry.t} on success
  • {:error, Tesla.Env.t} on failure

admin_set_snapshot_general_status(connection, id, set_snapshot_general_status_dto, opts \\ [])

@spec admin_set_snapshot_general_status(
  Tesla.Env.client(),
  String.t(),
  ExDaytona.Model.SetSnapshotGeneralStatusDto.t(),
  keyword()
) :: {:ok, ExDaytona.Model.SnapshotDto.t()} | {:error, Tesla.Env.t()}

Set snapshot general status

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t): Snapshot ID
  • set_snapshot_general_status_dto (SetSnapshotGeneralStatusDto):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.SnapshotDto.t} on success
  • {:error, Tesla.Env.t} on failure

admin_update_organization_preview_warning(connection, organization_id, organization_preview_warning, opts \\ [])

@spec admin_update_organization_preview_warning(
  Tesla.Env.client(),
  String.t(),
  ExDaytona.Model.OrganizationPreviewWarning.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Update organization preview warning

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t): Organization ID
  • organization_preview_warning (OrganizationPreviewWarning):
  • opts (keyword): Optional parameters

Returns

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

admin_update_organization_region_quota(connection, organization_id, region_id, update_organization_region_quota, opts \\ [])

@spec admin_update_organization_region_quota(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  ExDaytona.Model.UpdateOrganizationRegionQuota.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Update organization region quota

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • organization_id (String.t): Organization ID
  • region_id (String.t): Region ID
  • update_organization_region_quota (UpdateOrganizationRegionQuota):
  • opts (keyword): Optional parameters

Returns

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

admin_update_runner_scheduling(connection, id, opts \\ [])

@spec admin_update_runner_scheduling(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Update runner scheduling status

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

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