> ## 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.

# Environment の更新

> 指定された Environment の属性（名前、説明、設定など）を更新します。

`POST /api/v1/cloud/environments/{environment_id}`

指定された Environment の属性（名前、説明、設定など）を更新します。

## リクエストヘッダー

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

## パスパラメータ

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

## リクエストボディ

リクエストに含まれるフィールドのみ更新されます。省略されたフィールドは変更されません。

| フィールド         | 型                                                                                  | 必須  | 説明                                                            |
| ------------- | ---------------------------------------------------------------------------------- | --- | ------------------------------------------------------------- |
| `name`        | string                                                                             | いいえ | Environment 名                                                 |
| `description` | string                                                                             | いいえ | Environment の説明                                               |
| `config`      | [Environment config](/ja/cloud-agents/api/environments/schemas#environment-config) | いいえ | 保存済みの Environment 設定を置き換える                                    |
| `metadata`    | object                                                                             | いいえ | Metadata パッチ。文字列値はキーの追加・更新に、`null` 値は保存済み metadata からキーの削除に使用 |

## リクエスト例

```bash theme={null}
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**

```json theme={null}
{
  "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"
}
```

## レスポンスフィールド

| フィールド         | 型                                                                                  | 説明                                |
| ------------- | ---------------------------------------------------------------------------------- | --------------------------------- |
| `id`          | string                                                                             | Environment の一意識別子                |
| `type`        | string                                                                             | リソースタイプ、固定値 `"environment"`       |
| `name`        | string                                                                             | Environment 名                     |
| `description` | string                                                                             | 更新後の説明                            |
| `config`      | [Environment config](/ja/cloud-agents/api/environments/schemas#environment-config) | Environment 設定                    |
| `metadata`    | [Metadata オブジェクト](/ja/cloud-agents/api/conventions/schemas#metadata-オブジェクト)        | カスタムメタデータ                         |
| `archived_at` | string\|null                                                                       | アーカイブ時刻（ISO 8601）、未アーカイブ時は `null` |
| `created_at`  | string                                                                             | 作成時刻（ISO 8601）                    |
| `updated_at`  | string                                                                             | 最終更新時刻（最新の時刻に更新済み）                |

## エラーコード

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

## 注意事項

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

## 関連

<CardGroup cols={2}>
  <Card title="クラウド環境" icon="server" href="/ja/cloud-agents/environments">
    Agent が実行されるコンテナ、ネットワーク、依存関係を選択する。
  </Card>
</CardGroup>