メインコンテンツへスキップ
POST /v1/environments/{environment_id}/archive 指定された Environment をアーカイブします。アーカイブ後、Environment のステータスは "archived" に変わり、新しいセッションの作成には使えなくなります。ただし、すでに関連付けられているセッションには影響しません。

​
ヘッダー

ヘッダーフィールド値必須説明
AuthorizationBearer $QODER_PATはい個人アクセストークン

​
パスパラメータ

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

​
リクエストボディ

リクエストボディは不要です。

​
リクエスト例

curl -s -X POST 'https://api.qoder.com/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b/archive' \
  -H 'Authorization: Bearer $QODER_PAT'

​
レスポンス例

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

​
レスポンスフィールド

フィールド型説明
idstringEnvironment の一意識別子
typestringリソースタイプ、固定値 "environment"
namestringEnvironment 名
descriptionstringEnvironment の説明
statusstringEnvironment ステータス、アーカイブ後は "archived"
configobjectEnvironment 設定
created_atstring作成時刻（ISO 8601 形式）
updated_atstringアーカイブ操作の時刻（ISO 8601 形式）

​
エラーコード

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