Documentation Index
Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
Use this file to discover all available pages before exploring further.
DELETE /v1/agents/{agent_id}
指定された Agent を完全に削除します。この操作は元に戻せません。
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|
| Authorization | はい | Bearer <PAT> |
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|
agent_id | string | はい | Agent の一意識別子 |
リクエストボディ
リクエストボディは不要です。
リクエスト例
curl -X DELETE "https://openapi.qoder.sh/api/v1/cloud/agents/agent_019eXXXX..." \
-H "Authorization: Bearer $QODER_PAT"
レスポンス例
HTTP 200 OK
{
"type": "agent",
"id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"deleted": true
}
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|
type | string | 固定値 "agent" |
id | string | 削除された Agent の一意識別子 |
deleted | boolean | 固定値 true、削除成功を示す |
エラーコード
| HTTP | type | トリガー条件 |
|---|
| 401 | authentication_error | PAT が無効または期限切れ |
| 403 | permission_error | この Agent を削除する権限がない（admin ロールが必要な場合あり） |
| 404 | not_found_error | 指定 ID の Agent が存在しないか、すでに削除されている |
注意事項
- 削除操作は永続的で、復元できません。
- 一時的に Agent を停止したい場合は、アーカイブ（
POST /v1/agents/{agent_id}/archive）の使用を推奨します。
- アーカイブ済み Agent の削除も許可されます。
- 削除後、同じ ID で
DELETE を再度呼び出すと 404 が返されます。
- 一部のデプロイ環境では、削除操作に追加の管理者権限（
x-gw-roles: admin ヘッダー）が必要となる場合があります。この場合、権限がないと 403 が返されます。
削除前の推奨事項
- Agent に現在アクティブな Session が動いていないか確認してください。
- 永久削除が必要かどうか不確かな場合は、アーカイブ操作を優先してください。
- 削除前に、バージョン履歴エンドポイントで Agent の設定情報をバックアップしておくことを推奨します。
