指定した Identity の Drive を空にします。
Drive は現在 Beta 機能です。API 定義、レスポンス構造、動作は変更される可能性があります。ドキュメントの更新を確認し、本番環境で使用する前に互換性を検証してください。
DELETE /api/v1/forward/drives
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer <PAT or SAT> |
クエリパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| identity_id | string | はい | 現在の認証範囲内の Identity ID。必ず 1 回だけ指定します。Identity レベルの SAT は、紐付けられた Identity のみを選択できます。 |
リクエスト例
レスポンス例
HTTP 200 OK
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
| deleted_count | integer | 今回削除を確認したストレージオブジェクト数。Drive が既に空の場合は 0。 |
エラー
| HTTP | Code | 発生条件 |
|---|---|---|
| 400 | — | リクエストボディに未対応のフィールドが含まれるか、形式が不正です。 |
| 400 | invalid_drive_path | Identity 識別子の形式が無効です。 |
| 400 | invalid_identity_id | identity_id が未指定、空、または複数回指定されています。 |
| 401 | — | 認証情報が未指定または無効です。Service Account Key は事前に SAT と交換してください。 |
| 403 | identity_mismatch | Identity レベルの SAT で別の Identity を選択しています。 |
| 404 | identity_not_found | 現在の認証範囲内に Identity が見つかりません。 |
| 413 | — | リクエストボディがサービスの制限を超えています。 |
| 500 | — | 内部サーバーエラー。 |
| 503 | drive_delete_partial | 消去が未完了です。error.deleted_count は今回削除を確認した件数です。元のリクエストをリトライできます。 |
| 503 | drive_unavailable | Drive のストレージ、署名、または依存機能が一時的に利用できません。 |
HTTP エラーレスポンス
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
| type | string | 常に error。 |
| request_id | string | リクエスト追跡 ID。利用可能な場合に返されます。 |
| error.type | string | エラーの分類。例：invalid_request_error、authentication_error、permission_error、not_found_error、conflict_error、api_error。 |
| error.code | string | 業務エラーコード。一部の共通エラーでは返されません。 |
| error.message | string | エラーの説明。 |
| error.deleted_count | integer | drive_delete_partial の場合のみ返されます。今回削除を確認したオブジェクト数で、0 の場合もあります。 |
drive_delete_partial は削除が未完了であることを示します。削除済みファイルは復元されず、リトライでは残りのファイルのみを処理します。
入口での認証エラーは、異なるレスポンス構造になる場合があります。