コンテンツにスキップ

API

POST /api-keys

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します

Responses

Status CodeDescription
201APIキーが正常に作成されました。

GET /api-keys

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します

Responses

Status CodeDescription
200APIキーが正常に取得されました。
500APIキーの取得中にエラーが発生しました。

GET /api-keys/current

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)の ID を指定します

Responses

Status CodeDescription
200APIキーが正常に取得されました。

GET /api-keys/{name}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderいいえundefinedJWT と併用して 組織(Organization)の ID を指定します
namepathはいundefinedundefined

レスポンス

ステータスコード説明
200APIキーが正常に取得されました。

DELETE /api-keys/{name}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
namepathtrueundefinedundefined

レスポンス

ステータスコード説明
204APIキーは正常に削除されました。

GET /organizations/invitations

応答

ステータスコード説明
200組織の招待一覧

GET /organizations/invitations/count

レスポンス

ステータスコード説明
200組織の招待数

POST /organizations/invitations/{invitationId}/accept

Parameters

NameLocationRequiredTypeDescription
invitationIdpathtrueundefined招待ID

Responses

Status CodeDescription
200組織(Organization)の招待を正常に承諾しました

POST /organizations/invitations/{invitationId}/decline

パラメータ

名前位置必須説明
invitationIdpathtrueundefined招待ID

レスポンス

ステータスコード説明
200組織の招待を辞退しました

POST /organizations

Responses

Status CodeDescription
201組織の作成に成功しました

GET /organizations

レスポンス

ステータスコード説明
200組織のリスト

GET /organizations/{organizationId}

パラメータ

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織ID

レスポンス

Status CodeDescription
200組織の詳細

DELETE /organizations/{organizationId}

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織(Organization)ID

レスポンス

ステータスコード説明
204組織を正常に削除しました

GET /organizations/{organizationId}/usage

パラメータ

名前位置必須説明
organizationIdパス必須undefined組織ID

レスポンス

ステータスコード説明
200現在の利用状況の概要

PATCH /organizations/{organizationId}/quota

パラメータ

名前位置必須説明
organizationIdパス必須undefined組織ID

レスポンス

ステータスコード説明
200組織の詳細

POST /organizations/{organizationId}/leave

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織(Organization)ID

レスポンス

ステータスコード説明
204組織から正常に退出しました

POST /organizations/{organizationId}/suspend

パラメータ

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織(Organization)ID

応答

Status CodeDescription
204組織の一時停止に成功

POST /organizations/{organizationId}/unsuspend

Parameters

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織(Organization)ID

Responses

Status CodeDescription
204組織(Organization)の一時停止を解除しました

POST /organizations/{organizationId}/roles

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織ID

レスポンス

ステータスコード説明
201組織のロールを正常に作成しました

GET /organizations/{organizationId}/roles

Parameters

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織(Organization)ID

Responses

Status CodeDescription
200組織のロール一覧

PUT /organizations/{organizationId}/roles/{roleId}

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織ID
roleIdpathtrueundefinedロールID

レスポンス

ステータスコード説明
200ロールを正常に更新しました

DELETE /organizations/{organizationId}/roles/{roleId}

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織ID
roleIdpathtrueundefinedロールID

レスポンス

ステータスコード説明
204組織のロールを正常に削除しました

GET /organizations/{organizationId}/users

Parameters

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織(Organization)ID

Responses

Status CodeDescription
200組織メンバーのリスト

POST /organizations/{organizationId}/users/{userId}/role

パラメーター

名前位置必須説明
organizationIdpathtrueundefined組織(Organization)ID
userIdpathtrueundefinedユーザーID

レスポンス

ステータスコード説明
200ロールを正常に更新しました

POST /organizations/{organizationId}/users/{userId}/assigned-roles

Parameters

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織ID(Daytona内のリソースとユーザーのグループ化、ロールや請求など)
userIdpathtrueundefinedユーザーID

Responses

Status CodeDescription
200割り当て/ロールを正常に更新しました

DELETE /organizations/{organizationId}/users/{userId}

パラメーター

名前位置必須説明
organizationIdpathtrueundefined組織ID
userIdpathtrueundefinedユーザーID

レスポンス

ステータスコード説明
204組織からユーザーを正常に削除しました

POST /organizations/{organizationId}/invitations

Parameters

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織(Organization)ID

Responses

Status CodeDescription
201組織への招待が正常に作成されました

GET /organizations/{organizationId}/invitations

Parameters

NameLocationRequiredTypeDescription
organizationIdpathtrueundefined組織ID

Responses

Status CodeDescription
200未処理の組織招待の一覧

PUT /organizations/{organizationId}/invitations/{invitationId}

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織ID
invitationIdpathtrueundefined招待ID

レスポンス

ステータスコード説明
200組織の招待を正常に更新しました

POST /organizations/{organizationId}/invitations/{invitationId}/cancel

パラメータ

名前位置必須説明
organizationIdpathtrueundefined組織(Organization)ID
invitationIdpathtrueundefined招待(Invitation)ID

レスポンス

ステータスコード説明
204組織の招待を正常にキャンセルしました

GET /users/me

応答

ステータスコード説明
200ユーザー詳細

POST /users

レスポンス

ステータスコード説明
201

GET /users

レスポンス

ステータスコード説明
200

POST /users/{id}/regenerate-key-pair

パラメータ

名前位置必須説明
idパス必須未定義未定義

レスポンス

ステータスコード説明
201

GET /users/account-providers

レスポンス

ステータスコード説明
200利用可能なアカウントプロバイダー

POST /users/linked-accounts

レスポンス

ステータスコード説明
204アカウントのリンクが成功しました

DELETE /users/linked-accounts/{provider}/{providerUserId}

パラメーター

名称位置必須説明
providerpathtrueundefinedundefined
providerUserIdpathtrueundefinedundefined

レスポンス

ステータスコード説明
204アカウントの連携を解除しました

GET /users/{id}

パラメータ

名前位置必須説明
idパス必須未定義未定義

レスポンス

ステータスコード説明
200ユーザーの詳細

GET /sandbox

パラメータ

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定する
verbosequeryfalseundefined詳細出力を含める
labelsqueryfalseundefinedフィルタ用の JSON エンコード済みラベル

レスポンス

Status CodeDescription
200すべてのサンドボックス(Sandbox)の一覧

POST /sandbox

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します

レスポンス

ステータスコード説明
200サンドボックス(Sandbox)が正常に作成されました。

GET /sandbox/{sandboxId}

パラメータ

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定
verbosequeryfalseundefined詳細出力を含める
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID

レスポンス

Status CodeDescription
200サンドボックスの詳細

DELETE /sandbox/{sandboxId}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID
forcequerytrueundefined強制削除を行うかどうか

レスポンス

ステータスコード説明
200サンドボックスを削除しました

POST /sandbox/{sandboxId}/start

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID

Responses

Status CodeDescription
200サンドボックスを起動しました

POST /sandbox/{sandboxId}/stop

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID

レスポンス

ステータスコード説明
200サンドボックスを停止しました

PUT /sandbox/{sandboxId}/labels

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)の ID を指定します
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID

Responses

Status CodeDescription
200ラベルを正常に置換しました

POST /sandbox/{sandboxId}/backup

パラメータ

名前ロケーション必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)の ID を指定します
sandboxIdpathtrueundefinedサンドボックス(隔離された一時的な実行環境)の ID

レスポンス

ステータスコード説明
200サンドボックスのバックアップの開始を受け付けました

POST /sandbox/{sandboxId}/public/{isPublic}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID
isPublicpathtrueundefined設定する公開状態

レスポンス

ステータスコード説明
201

POST /sandbox/{sandboxId}/autostop/{interval}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID
intervalpathtrueundefined自動停止(Auto-stop)の間隔(分)。0 で無効化

レスポンス

ステータスコード説明
200自動停止(Auto-stop)の間隔を設定しました

POST /sandbox/{sandboxId}/autoarchive/{interval}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderいいえundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathはいundefinedサンドボックス(Sandbox)の ID
intervalpathはいundefined自動アーカイブ(Auto-archive)の間隔(分)。0 の場合は最大間隔が適用されます

レスポンス

ステータスコード説明
200自動アーカイブの間隔を設定しました

POST /sandbox/{sandboxId}/archive

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

レスポンス

ステータスコード説明
200サンドボックス(Sandbox)をアーカイブしました

GET /sandbox/{sandboxId}/ports/{port}/preview-url

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID
portpathtrueundefinedプレビューリンクの URL を取得するポート番号

Responses

Status CodeDescription
200指定したポートのプレビューリンクの URL

GET /sandbox/{sandboxId}/build-logs

パラメータ

名前位置必須説明
X-Daytona-Organization-IDヘッダーいいえ未定義JWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)の ID を指定
sandboxIdパスはい未定義サンドボックス(隔離された一時的な実行環境)の ID
followクエリいいえ未定義ログストリームをフォローするかどうか

レスポンス

ステータスコード説明
200ビルドログのストリーム

POST /runners

レスポンス

ステータスコード説明
201

GET /runners

レスポンス

ステータスコード説明
200

PATCH /runners/{id}/scheduling

パラメーター

名前位置必須説明
idパス必須未定義未定義

レスポンス

ステータスコード説明
200

GET /runners/by-sandbox/{sandboxId}

パラメータ

名前位置必須説明
sandboxIdpathtrueundefinedundefined

レスポンス

ステータスコード説明
200ランナー(サンドボックスがスケジュールおよび実行される基盤の計算ノード/ホスト)が見つかりました

GET /runners/by-snapshot

Parameters

NameLocationRequiredTypeDescription
internalNamequerytrueundefinedスナップショットの内部名

Responses

Status CodeDescription
200スナップショットに対して見つかったランナー(サンドボックスがスケジュールおよび実行される基盤の計算ノード/ホスト)

GET /toolbox/{sandboxId}/toolbox/project-dir

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して、組織(Organization)IDを指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200プロジェクトディレクトリを正常に取得しました

GET /toolbox/{sandboxId}/toolbox/files

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderいいえundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathはいundefinedなし
pathqueryいいえundefinedなし

レスポンス

ステータスコード説明
200ファイル一覧の取得に成功

DELETE /toolbox/{sandboxId}/toolbox/files

サンドボックス内のファイルを削除

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedなし
pathquerytrueundefinedなし

Responses

ステータスコード説明
200ファイルを正常に削除しました

GET /toolbox/{sandboxId}/toolbox/files/download

サンドボックスからファイルをダウンロード

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

ステータスコード説明
200ファイルを正常にダウンロードしました

GET /toolbox/{sandboxId}/toolbox/files/find

サンドボックス内のファイルでテキスト/パターンを検索

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
patternquerytrueundefinedundefined

Responses

Status CodeDescription
200検索が正常に完了しました

POST /toolbox/{sandboxId}/toolbox/files/folder

サンドボックス内にフォルダを作成

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefined未定義
pathquerytrueundefined未定義
modequerytrueundefined未定義

Responses

ステータスコード説明
200フォルダを作成しました

GET /toolbox/{sandboxId}/toolbox/files/info

サンドボックス内のファイル情報を取得

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200ファイル情報の取得に成功

POST /toolbox/{sandboxId}/toolbox/files/move

サンドボックス内のファイルを移動

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)ID を指定します
sandboxIdpathtrueundefinedundefined
sourcequerytrueundefinedundefined
destinationquerytrueundefinedundefined

Responses

Status CodeDescription
200ファイルを正常に移動しました

POST /toolbox/{sandboxId}/toolbox/files/permissions

サンドボックス内のファイルの所有者/グループ/権限を設定

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
ownerqueryfalseundefinedundefined
groupqueryfalseundefinedundefined
modequeryfalseundefinedundefined

Responses

Status CodeDescription
200ファイルの権限を正常に更新しました

POST /toolbox/{sandboxId}/toolbox/files/replace

サンドボックス(隔離された一時的な実行環境)内の複数ファイルでテキスト/パターンを一括置換する

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定する
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200テキストを正常に置換しました

GET /toolbox/{sandboxId}/toolbox/files/search

サンドボックス(隔離された一時的な実行環境)内のファイルを検索

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(組織)IDを指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
patternquerytrueundefinedundefined

Responses

Status CodeDescription
200検索が正常に完了しました

POST /toolbox/{sandboxId}/toolbox/files/upload

サンドボックス内にファイルをアップロード

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)ID を指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200ファイルのアップロードに成功しました

POST /toolbox/{sandboxId}/toolbox/files/bulk-upload

サンドボックス内に複数ファイルをアップロード

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織 ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200ファイルを正常にアップロードしました

POST /toolbox/{sandboxId}/toolbox/git/add

ファイルを Git のコミットに追加します

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して、組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200ファイルを Git に正常に追加しました

GET /toolbox/{sandboxId}/toolbox/git/branches

Git リポジトリからブランチ一覧を取得

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)ID を指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200ブランチ一覧の取得に成功しました

POST /toolbox/{sandboxId}/toolbox/git/branches

Git リポジトリにブランチを作成

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200ブランチの作成に成功しました

DELETE /toolbox/{sandboxId}/toolbox/git/branches

Git リポジトリのブランチを削除

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200ブランチを正常に削除しました

POST /toolbox/{sandboxId}/toolbox/git/clone

Gitリポジトリをクローンする

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200リポジトリを正常にクローンしました

POST /toolbox/{sandboxId}/toolbox/git/commit

Git リポジトリに変更をコミットします

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織 ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200変更のコミットに成功しました

GET /toolbox/{sandboxId}/toolbox/git/history

Git リポジトリのコミット履歴を取得

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)ID を指定する
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

ステータスコード説明
200コミット履歴を正常に取得しました

POST /toolbox/{sandboxId}/toolbox/git/pull

リモートから変更を取得する(pull)

Parameters

名称位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定する
sandboxIdpathtrueundefinedundefined

Responses

ステータスコード説明
200変更を正常に取得しました

POST /toolbox/{sandboxId}/toolbox/git/push

変更をリモートにプッシュする

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)IDを指定する
sandboxIdpathtrueundefinedundefined

Responses

ステータスコード説明
200変更のプッシュに成功

POST /toolbox/{sandboxId}/toolbox/git/checkout

git リポジトリでブランチまたはコミットをチェックアウトする

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定する
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200ブランチを正常にチェックアウトしました

GET /toolbox/{sandboxId}/toolbox/git/status

Git リポジトリのステータスを取得

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200Git ステータスを正常に取得しました

POST /toolbox/{sandboxId}/toolbox/process/execute

サンドボックス(隔離された一時的な実行環境)内でコマンドを同期的に実行します

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)の ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200コマンドが正常に実行されました

GET /toolbox/{sandboxId}/toolbox/process/session

サンドボックス内のすべてのアクティブなセッションを一覧表示します

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200セッションを正常に取得しました

POST /toolbox/{sandboxId}/toolbox/process/session

サンドボックス(隔離された一時的な実行環境)内で新しいセッションを作成する

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定する
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200

GET /toolbox/{sandboxId}/toolbox/process/session/{sessionId}

IDでセッションを取得する

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderいいえundefinedJWTと併用して組織(Organization)IDを指定します
sandboxIdpathはいundefinedundefined
sessionIdpathはいundefinedundefined

Responses

ステータスコード説明
200セッションの取得に成功しました

DELETE /toolbox/{sandboxId}/toolbox/process/session/{sessionId}

特定のセッションを削除します

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined

Responses

ステータスコード説明
200セッションを正常に削除しました

POST /toolbox/{sandboxId}/toolbox/process/session/{sessionId}/exec

特定のセッションでコマンドを実行する

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定する
sandboxIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined

Responses

Status CodeDescription
200コマンドが正常に実行された
202コマンドを受け付け、処理中

GET /toolbox/{sandboxId}/toolbox/process/session/{sessionId}/command/{commandId}

IDでセッションコマンドを取得

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織IDを指定
sandboxIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined
commandIdpathtrueundefinedundefined

Responses

Status CodeDescription
200セッションコマンドを正常に取得

GET /toolbox/{sandboxId}/toolbox/process/session/{sessionId}/command/{commandId}/logs

セッション内の特定のコマンドのログを取得します

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined
commandIdpathtrueundefinedundefined
followqueryfalseundefinedundefined

Responses

Status CodeDescription
200コマンドのログストリーム

POST /toolbox/{sandboxId}/toolbox/lsp/completions

Completion リクエストは、指定したカーソル位置の補完候補を算出するために、クライアントからサーバーへ送信されます。

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織 ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

POST /toolbox/{sandboxId}/toolbox/lsp/did-close

ドキュメントがクライアント側で閉じられた際に、クライアントからサーバーへ送信されるドキュメントクローズ通知です。

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

POST /toolbox/{sandboxId}/toolbox/lsp/did-open

ドキュメントのオープン通知は、新規に開いたテキストドキュメントを知らせるため、クライアントからサーバーへ送信されます。

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

GET /toolbox/{sandboxId}/toolbox/lsp/document-symbols

ドキュメントシンボルのリクエストはクライアントからサーバーに送信されます。

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined
languageIdquerytrueundefinedundefined
pathToProjectquerytrueundefinedundefined
uriquerytrueundefinedundefined

Responses

Status CodeDescription
200OK

POST /toolbox/{sandboxId}/toolbox/lsp/start

サンドボックスのプロジェクト内で LSP(言語サーバープロトコル)サーバープロセスを開始します

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

Status CodeDescription
200正常

POST /toolbox/{sandboxId}/toolbox/lsp/stop

サンドボックス内のプロジェクトで動作する LSP(言語サーバープロトコル)サーバープロセスを停止します

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
sandboxIdpathtrueundefinedundefined

Responses

ステータスコード説明
200OK

GET /toolbox/{sandboxId}/toolbox/lsp/workspace-symbols

ワークスペースシンボルリクエストは、クライアントからサーバーに送られ、クエリ文字列に合致するプロジェクト全体のシンボルを一覧します。

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定します
sandboxIdpathtrueundefinedundefined
languageIdquerytrueundefinedundefined
pathToProjectquerytrueundefinedundefined
queryquerytrueundefinedundefined

Responses

Status CodeDescription
200OK

POST /snapshots

Parameters

名前位置必須説明
X-Daytona-Organization-IDheaderいいえundefinedJWT と併用して 組織(Organization)ID を指定します

Responses

ステータスコード説明
200スナップショットが正常に作成されました。
400不正なリクエスト - タグ「:latest 」のスナップショットは許可されていません

GET /snapshots

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)のIDを指定
limitqueryfalseundefined1ページあたりの件数
pagequeryfalseundefinedページ番号

レスポンス

ステータスコード説明
200ページネーション対応のスナップショット(Snapshot)一覧

GET /snapshots/{id}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)IDを指定
idpathtrueundefinedスナップショット(Snapshot)のIDまたは名前

レスポンス

ステータスコード説明
200スナップショット
404スナップショットが見つかりません

DELETE /snapshots/{id}

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
idpathtrueundefinedスナップショット(Snapshot)ID

Responses

Status CodeDescription
200スナップショットを削除しました

PATCH /snapshots/{id}/toggle

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)のIDを指定します
idpathtrueundefinedスナップショット(Snapshot)のID

Responses

Status CodeDescription
200スナップショットの状態を切り替えました

PATCH /snapshots/{id}/general

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
idpathtrueundefinedスナップショット(Snapshot)ID

レスポンス

ステータスコード説明
200スナップショットの general ステータスが設定されました

GET /snapshots/{id}/build-logs

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定
idpathtrueundefinedスナップショット(Snapshot)ID
followqueryfalseundefinedログストリームをフォローするかどうか

レスポンス

ステータスコード説明
200

POST /snapshots/{id}/activate

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します
idpathtrueundefinedスナップショット(Snapshot)ID

Responses

Status CodeDescription
200スナップショットを正常に有効化しました。
400不正なリクエスト - スナップショットがすでに有効、非アクティブ状態ではない、または関連するランナー(サンドボックスがスケジュールおよび実行される基盤の計算ノード/ホスト)があります
404スナップショットが見つかりません

GET /workspace

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定する
verbosequeryfalseundefined詳細出力を含める
labelsqueryfalseundefinedフィルタに使用する JSON エンコード済みラベル

レスポンス

ステータスコード説明
200すべてのワークスペースの一覧

POST /workspace

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織IDを指定します

Responses

Status CodeDescription
200ワークスペースの作成に成功しました。

GET /workspace/{workspaceId}

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)の ID を指定
verbosequeryfalseundefined冗長な出力を含める
workspaceIdpathtrueundefinedワークスペースの ID

Responses

Status CodeDescription
200ワークスペースの詳細

DELETE /workspace/{workspaceId}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定
workspaceIdpathtrueundefinedワークスペースの ID
forcequerytrueundefined未定義

レスポンス

ステータスコード説明
200ワークスペースを削除しました

POST /workspace/{workspaceId}/start

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
workspaceIdpathtrueundefinedワークスペースの ID

Responses

Status CodeDescription
200ワークスペースを起動しました

POST /workspace/{workspaceId}/stop

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
workspaceIdpathtrueundefinedワークスペースのID

Responses

Status CodeDescription
200ワークスペースを停止しました

PUT /workspace/{workspaceId}/labels

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
workspaceIdpathtrueundefinedワークスペース ID

Responses

Status CodeDescription
200ラベルを正常に置換しました

POST /workspace/{workspaceId}/backup

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)のIDを指定します
workspaceIdpathtrueundefinedワークスペースのID

Responses

Status CodeDescription
200ワークスペースのバックアップの開始を受け付けました

POST /workspace/{workspaceId}/public/{isPublic}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)の ID を指定します
workspaceIdpathtrueundefinedワークスペースの ID
isPublicpathtrueundefined設定する公開ステータス

レスポンス

ステータスコード説明
201

POST /workspace/{workspaceId}/autostop/{interval}

パラメータ

名前ロケーション必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)ID を指定します
workspaceIdpathtrueundefinedワークスペースのID
intervalpathtrueundefined自動停止(サンドボックスのライフサイクルを制御する自動タイマー)の間隔(分)。0 で無効化

レスポンス

ステータスコード説明
200自動停止(サンドボックスのライフサイクルを制御する自動タイマー)の間隔を設定しました

POST /workspace/{workspaceId}/autoarchive/{interval}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)のIDを指定します
workspaceIdpathtrueundefinedワークスペースのID
intervalpathtrueundefined自動アーカイブ間隔(分)。0 を指定すると最大間隔が使用されます

レスポンス

ステータスコード説明
200自動アーカイブ間隔を設定しました

POST /sandbox/{sandboxId}/autodelete/{interval}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定
sandboxIdpathtrueundefinedサンドボックス(Sandbox)の ID
intervalpathtrueundefined自動削除の間隔(分)。負の値で無効、0 で停止時に即時削除

レスポンス

ステータスコード説明
200自動削除の間隔を設定しました

POST /workspace/{workspaceId}/archive

パラメータ

名前位置必須説明
X-Daytona-Organization-IDヘッダーいいえ未定義JWT と併用して組織(Organization)IDを指定します
workspaceIdパスはい未定義未定義

レスポンス

ステータスコード説明
200ワークスペースをアーカイブしました

GET /workspace/{workspaceId}/ports/{port}/preview-url

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定
workspaceIdpathtrueundefinedワークスペース ID
portpathtrueundefinedプレビューリンクを取得するポート番号

Responses

Status CodeDescription
200指定したポートのプレビューリンク

GET /workspace/{workspaceId}/build-logs

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWTと併用して組織(Organization)のIDを指定します
workspaceIdpathtrueundefinedワークスペースID
followqueryfalseundefinedログストリームをフォローするかどうか

Responses

Status CodeDescription
200ビルドログのストリーム

GET /preview/{sandboxId}/public

Parameters

NameLocationRequiredTypeDescription
sandboxIdpathtrueundefinedサンドボックス(隔離された一時的な実行環境)のID

Responses

Status CodeDescription
200サンドボックスの公開状態

GET /preview/{sandboxId}/validate/{authToken}

Parameters

NameLocationRequiredTypeDescription
sandboxIdpathtrueundefinedサンドボックスのID
authTokenpathtrueundefinedサンドボックスの認証トークン

Responses

Status CodeDescription
200サンドボックス認証トークンの検証結果

GET /preview/{sandboxId}/access

パラメータ

名前位置必須説明
sandboxIdパス必須undefinedundefined

レスポンス

ステータスコード説明
200

GET /volumes

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して 組織(Organization)ID を指定します
includeDeletedqueryfalseundefinedレスポンスに削除済みのボリューム(Volume)を含めます

Responses

Status CodeDescription
200すべてのボリューム(Volume)の一覧

POST /volumes

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Daytona内のリソースとユーザーのグループ化、ロールや請求など)の ID を指定します

Responses

Status CodeDescription
200ボリューム(S3互換オブジェクトストレージをバックエンドに持つFUSEベースの共有ストレージ)が正常に作成されました。

GET /volumes/{volumeId}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)のIDを指定します
volumeIdpathtrueundefinedボリューム(Volume)のID

レスポンス

ステータスコード説明
200ボリュームの詳細

DELETE /volumes/{volumeId}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Daytona 内のリソースとユーザーのグループ化、ロールや請求など)の ID を指定します
volumeIdpathtrueundefinedボリューム(S3互換オブジェクトストレージをバックエンドに持つFUSEベースの共有ストレージ)の ID

レスポンス

ステータスコード説明
200ボリュームは削除対象としてマークされました

GET /volumes/by-name/{name}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
namepathtrueundefinedボリューム(S3互換オブジェクトストレージをバックエンドに持つFUSEベースの共有ストレージ)の名前

レスポンス

ステータスコード説明
200ボリュームの詳細

POST /docker-registry

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して、組織(Organization)のIDを指定します

Responses

Status CodeDescription
201Dockerレジストリが正常に作成されました。

GET /docker-registry

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderいいえundefinedJWT と併用して組織(Organization)ID を指定する

レスポンス

ステータスコード説明
200すべての Docker レジストリの一覧

GET /docker-registry/registry-push-access

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して、組織(Organization)ID を指定します

Responses

Status CodeDescription
200一時的なレジストリへのアクセス権が発行されました

GET /docker-registry/{id}

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)の ID を指定します
idpathtrueundefinedDocker レジストリの ID

Responses

Status CodeDescription
200Docker レジストリ

PATCH /docker-registry/{id}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織 ID を指定します
idpathtrueundefinedDocker レジストリの ID

レスポンス

ステータスコード説明
200Docker レジストリを正常に更新しました。

DELETE /docker-registry/{id}

パラメータ

名前位置必須説明
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
idpathtrueundefinedDocker レジストリの ID

レスポンス

ステータスコード説明
204Docker レジストリが正常に削除されました。

POST /docker-registry/{id}/set-default

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します
idpathtrueundefinedDocker レジストリの ID

Responses

Status CodeDescription
200Docker レジストリをデフォルトに設定しました。

GET /object-storage/push-access

Parameters

NameLocationRequiredTypeDescription
X-Daytona-Organization-IDheaderfalseundefinedJWT と併用して組織(Organization)ID を指定します

Responses

Status CodeDescription
200一時的なストレージアクセスが生成されます