本文へ
ドキュメントAPI リファレンスサーバー操作を実行
POSTBearer トークン

サーバー操作を実行

/api/v1/servers/:id/actions

所属組織のサーバーの起動、正常なシャットダウン(shutdown)、強制電源オフ(stop)、再起動、パスワードのリセット、再インストール、サービス終了を実行します。

呼び出す前に

再インストールではデータが消去されます。サービス終了では返金もプロバイダー契約の解約も行われません。破壊的な操作には confirm=true が必要で、AI の terminate/reinstall には一致するウォレット署名証明も必要です。202 は受付済みを意味し、完了ではありません。結果不明の場合は taskKey で照会してください。

API のフィールド名、型、コードはすべての言語で共通です。

リクエスト例

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/actions" -X POST \
  -H "Authorization: Bearer $TOVAHUB_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "action": "restart",
  "requestKey": "docs_example_001"
}'

表示のみ。このページから API リクエストは送信されません。

レスポンス例
JSON
{
  "ok": true,
  "pending": true,
  "replay": false,
  "simulated": false,
  "error": null,
  "taskKey": "server:507f1f77bcf86cd799439012:restart:restart_001"
}

パラメーター

idパス · 必須

string

リソース ID。24 桁の16進数文字列です。対応する一覧エンドポイントが返すプラットフォーム ID を使用し、プロバイダーのインスタンス ID は使用しないでください。

actionJSON ボディ · 必須

"start" | "shutdown" | "stop" | "restart" | "changepass" | "reinstall" | "terminate"

実行する操作。

requestKeyJSON ボディ · 必須

string

8–100 文字。使用できるのは A–Z、a–z、0–9、アンダースコア、ハイフンです。同じ操作を再試行するときは、同じキーと完全に同じ入力を使用してください。

confirmJSON ボディ · 任意

boolean

影響を確認後にのみtrueにします。stop(強制電源オフ)、terminate、reinstall、changepass、スナップショットの削除・復元で必須です。

osJSON ボディ · 任意

string

OS 識別子。標準の選択肢には debian12 と ubuntu24 があります。利用可否とライセンスは選択したプランに対して検証されます。サーバー操作とそのチャレンジでは、reinstall のみが os を受け付けます。

proofJSON ボディ · 任意

object

AI の terminate/reinstall の承認証明:{ challengeId: string(24 桁の16進数), signature: string(20–200 文字)}。同一の action、requestKey、OS に対するチャレンジを取得し、返されたメッセージを変更せずローカルで署名してください。

レスポンス

HTTP ステータス 200 / 202

送信したサーバー操作の受付結果を返します。処理中または結果が不確かな場合は、元のタスクを照会してください。

okboolean

内部の操作が ok を返したかどうか。

pendingboolean

true の場合は HTTP ステータス 202、それ以外は 200。

replayboolean

元のリクエストの結果を再返却したものかどうか。

simulatedboolean

操作が隔離されたテスト動作を使用したかどうか。

errorunknown | null

内部の操作のエラー値、または null。より詳細な実行時出力の構造は定義されていません。

taskKeystring

固定キー server:<platform-server-id>:<action>:<requestKey>。