メインコンテンツへスキップ
POST /api/v1/cloud/environments/{environment_id} 指定された Environment の属性（名前、説明、設定など）を更新します。

​
リクエストヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT>
Content-Typeはいapplication/json

​
パスパラメータ

パラメータ型必須説明
environment_idstringはいEnvironment の一意識別子（env_ プレフィックス付き）

​
リクエストボディ

リクエストに含まれるフィールドのみ更新されます。省略されたフィールドは変更されません。
フィールド型必須説明
namestringいいえEnvironment 名
descriptionstringいいえEnvironment の説明
configEnvironment configいいえ保存済みの Environment 設定を置き換える
metadataobjectいいえMetadata パッチ。文字列値はキーの追加・更新に、null 値は保存済み metadata からキーの削除に使用

​
リクエスト例

curl -s -X POST 'https://api.qoder.com/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Environment used for API documentation testing"
  }'

​
レスポンス例

HTTP 200 OK 
{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "Environment used for API documentation testing",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited",
      "allowed_hosts": [],
      "allow_package_managers": false,
      "allow_mcp_servers": false
    },
    "packages": {
      "type": "packages",
      "apt": ["curl"],
      "npm": [],
      "pip": []
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.093156Z"
}

​
レスポンスフィールド

フィールド型説明
idstringEnvironment の一意識別子
typestringリソースタイプ、固定値 "environment"
namestringEnvironment 名
descriptionstring更新後の説明
configEnvironment configEnvironment 設定
metadataMetadata オブジェクトカスタムメタデータ
archived_atstring|nullアーカイブ時刻（ISO 8601）、未アーカイブ時は null
created_atstring作成時刻（ISO 8601）
updated_atstring最終更新時刻（最新の時刻に更新済み）

​
エラーコード

HTTPtype説明
400invalid_request_errorリクエストボディ、config または metadata の値が不正
401authentication_error認証失敗、PAT が無効または期限切れ
403permission_errorこのリソースへのアクセス権限がない
404not_found_error指定 ID の Environment が存在しない

​
注意事項

  • 省略されたフィールドは変更されません。
  • config を明示的に指定した場合、リクエスト内の設定で保存済みの設定が完全に置き換えられます。
  • metadata を明示的に指定した場合、文字列値は保存済み metadata オブジェクトにマージされ、null 値は既存のキーを削除します。

​
関連

クラウド環境

Agent が実行されるコンテナ、ネットワーク、依存関係を選択する。