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.
PUT /v1/environments/{environment_id}
指定された Environment の属性(名前、説明、設定など)を更新します。
ヘッダー
| ヘッダーフィールド | 値 | 必須 | 説明 |
|---|
| Authorization | Bearer $QODER_PAT | はい | 個人アクセストークン |
| Content-Type | application/json | はい | リクエストボディの形式 |
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|
environment_id | string | はい | Environment の一意識別子(env_ プレフィックス) |
リクエストボディ
更新するフィールドのみを渡します。渡されなかったフィールドは変更されません。
| フィールド | 型 | 必須 | 説明 |
|---|
name | string | いいえ | 新しい Environment 名 |
description | string | いいえ | 新しい Environment の説明 |
config | object | いいえ | 新しい Environment 設定 |
config.type | string | はい(config を渡す場合) | 固定値 "cloud" |
config.networking | object | いいえ | ネットワークアクセス設定 |
config.networking.type | string | いいえ | ネットワークタイプ: "unrestricted"、"limited"、"allowlist" |
config.networking.allowed_hosts | array | いいえ | アクセスを許可するホストリスト |
config.networking.allow_package_managers | boolean | いいえ | パッケージマネージャーのネットワークアクセスを許可するか |
config.packages | object | いいえ | 事前インストールパッケージ設定 |
config.packages.apt | array | いいえ | apt パッケージリスト |
config.packages.pip | array | いいえ | pip パッケージリスト |
config.packages.npm | array | いいえ | npm パッケージリスト |
metadata | object | いいえ | カスタムメタデータのキーバリュー |
リクエスト例
curl -s -X PUT 'https://openapi.qoder.sh/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"
]
}
},
"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 | 更新後の説明 |
status | string | Environment ステータス |
config | object | Environment 設定 |
created_at | string | 作成時刻(ISO 8601 形式) |
updated_at | string | 最終更新時刻(最新時刻に更新済み) |
エラーコード
| HTTP ステータスコード | エラータイプ | 説明 |
|---|
| 400 | invalid_request_error | リクエストパラメータが無効 |
| 401 | authentication_error | 認証失敗、PAT が無効または期限切れ |
| 403 | permission_error | このリソースにアクセスする権限がない |
| 404 | not_found_error | 指定 ID の Environment が存在しない |