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

​
ヘッダー

ヘッダーフィールド値必須説明
AuthorizationBearer $QODER_PATはい個人アクセストークン
Content-Typeapplication/jsonはいリクエストボディの形式

​
パスパラメータ

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

​
リクエストボディ

更新するフィールドのみを渡します。渡されなかったフィールドは変更されません。
フィールド型必須説明
namestringいいえEnvironment 名
descriptionstringいいえEnvironment の説明
configEnvironment configいいえ保存済みの Environment 設定を置換します
metadataMetadata objectいいえメタデータパッチ。このオブジェクトのキーが保存済みメタデータにマージされます。値は文字列である必要があります

​
リクエスト例

curl -s -X PUT 'https://api.qoder.com/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b' \
  -H 'Authorization: Bearer $QODER_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "API ドキュメントテスト用の Environment"
  }'

​
レスポンス例

{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "API ドキュメントテスト用の Environment",
  "status": "ready",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited"
    },
    "packages": {
      "apt": [
        "curl"
      ]
    }
  },
  "metadata": {},
  "archived": false,
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.093156Z"
}

​
レスポンスフィールド

フィールド型説明
idstringEnvironment の一意識別子
typestringリソースタイプ、固定値 "environment"
namestringEnvironment 名
descriptionstring更新後の説明
statusstringEnvironment ステータス
configEnvironment configEnvironment 設定
metadataMetadata objectカスタムメタデータ
archivedbooleanアーカイブ済みかどうか（デフォルト false）
archived_atstring|nullアーカイブ時刻（ISO 8601）、未アーカイブの場合は null
created_atstring作成時刻（ISO 8601 形式）
updated_atstring最終更新時刻（最新時刻に更新済み）

​
エラーコード

HTTP ステータスコードエラータイプ説明
400invalid_request_errorリクエストボディ、config、または metadata 値が無効
401authentication_error認証失敗、PAT が無効または期限切れ
403permission_errorこのリソースにアクセスする権限がない
404not_found_error指定 ID の Environment が存在しない
エラーで完全なエラーエンベロープを参照してください。

​
注意事項

  • 省略されたフィールドは変更されません。
  • config を指定した場合、保存済みの設定を置換します。
  • metadata を指定した場合、キーが保存済みメタデータオブジェクトにマージされます。

​
関連項目

クラウド環境

Agent が動作するコンテナ、ネットワーク、依存関係を選択する。