メインコンテンツへスキップ

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/environments/{environment_id} 指定された Environment を完全に削除します。この操作は元に戻せず、管理者権限が必要です。

ヘッダー

ヘッダーフィールド必須説明
AuthorizationBearer $QODER_PATはい個人アクセストークン(管理者権限が必要)

パスパラメータ

パラメータ必須説明
environment_idstringはいEnvironment の一意識別子(env_ プレフィックス)

リクエストボディ

リクエストボディは不要です。

リクエスト例

curl -s -X DELETE 'https://openapi.qoder.sh/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b' \
  -H 'Authorization: Bearer $QODER_PAT'

レスポンス例

成功時は空のレスポンスボディと HTTP ステータスコード 204 を返します。 権限不足時はエラーを返します:
{
  "type": "error",
  "error": {
    "type": "permission_error",
    "message": "You do not have permission to access this resource."
  }
}

エラーコード

HTTP ステータスコードエラータイプ説明
401authentication_error認証失敗、PAT が無効または期限切れ
403permission_error削除操作を実行する権限がない(管理者権限が必要)
404not_found_error指定 ID の Environment が存在しない

注意事項

  • このエンドポイントは管理者レベルの PAT 権限が必要です。一般ユーザーが呼び出すと 403 エラーが返されます。
  • 削除前にアーカイブエンドポイント(POST /v1/environments/{environment_id}/archive)でアーカイブ操作を行うことを推奨します。
  • Environment にアクティブなセッションが残っている場合、削除が失敗する可能性があります。