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

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 の属性(名前、説明、設定など)を更新します。

ヘッダー

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

パスパラメータ

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

リクエストボディ

更新するフィールドのみを渡します。渡されなかったフィールドは変更されません。
フィールド必須説明
namestringいいえ新しい Environment 名
descriptionstringいいえ新しい Environment の説明
configobjectいいえ新しい Environment 設定
config.typestringはい(config を渡す場合)固定値 "cloud"
config.networkingobjectいいえネットワークアクセス設定
config.networking.typestringいいえネットワークタイプ: "unrestricted""limited""allowlist"
config.networking.allowed_hostsarrayいいえアクセスを許可するホストリスト
config.networking.allow_package_managersbooleanいいえパッケージマネージャーのネットワークアクセスを許可するか
config.packagesobjectいいえ事前インストールパッケージ設定
config.packages.aptarrayいいえapt パッケージリスト
config.packages.piparrayいいえpip パッケージリスト
config.packages.npmarrayいいえnpm パッケージリスト
metadataobjectいいえカスタムメタデータのキーバリュー

リクエスト例

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"
}

レスポンスフィールド

フィールド説明
idstringEnvironment の一意識別子
typestringリソースタイプ、固定値 "environment"
namestringEnvironment 名
descriptionstring更新後の説明
statusstringEnvironment ステータス
configobjectEnvironment 設定
created_atstring作成時刻(ISO 8601 形式)
updated_atstring最終更新時刻(最新時刻に更新済み)

エラーコード

HTTP ステータスコードエラータイプ説明
400invalid_request_errorリクエストパラメータが無効
401authentication_error認証失敗、PAT が無効または期限切れ
403permission_errorこのリソースにアクセスする権限がない
404not_found_error指定 ID の Environment が存在しない