Environment のアーカイブ

POST /api/v1/cloud/environments/{environment_id}/archive 指定された Environment をアーカイブします。アーカイブ後、archived_at が設定され、新しいセッションのホストには使用できなくなりますが、既存のセッションには影響しません。

リクエストヘッダー

ヘッダー	必須	説明
`Authorization`	はい	`Bearer <PAT または SAT>`

パスパラメータ

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

リクエストボディ

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

リクエスト例

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

レスポンス例

HTTP 200 OK

{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "Environment used for API documentation testing",
  "config": {
    "type": "cloud",
    "packages": {
      "type": "packages",
      "apt": ["curl"],
      "cargo": [],
      "gem": [],
      "go": [],
      "npm": [],
      "pip": []
    }
  },
  "metadata": {},
  "archived_at": "2026-05-18T15:28:08.459536Z",
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.459536Z"
}

レスポンスフィールド

フィールド	型	説明
`id`	string	Environment の一意識別子
`type`	string	リソースタイプ、固定値 `"environment"`
`name`	string	Environment 名
`description`	string	Environment の説明
`config`	Environment config	Environment 設定
`metadata`	Metadata オブジェクト	カスタムメタデータ
`archived_at`	string\|null	アーカイブ時刻（ISO 8601）
`created_at`	string	作成時刻（ISO 8601）
`updated_at`	string	アーカイブ操作の時刻（ISO 8601）

エラーコード

HTTP	type	説明
401	`authentication_error`	認証失敗、PAT または SAT が無効または期限切れ
403	`permission_error`	このリソースへのアクセス権限がない
404	`not_found_error`	指定 ID の Environment が存在しない

注意事項

アーカイブ操作はべき等です。すでにアーカイブ済みの Environment を再度アーカイブしてもエラーにはなりません。

クラウド環境

Agent が実行されるコンテナ、ネットワーク、依存関係を選択する。

​リクエストヘッダー

​パスパラメータ

​リクエストボディ

​リクエスト例

​レスポンス例

​レスポンスフィールド

​エラーコード

​注意事項

​関連

クラウド環境

リクエストヘッダー

パスパラメータ

リクエストボディ

リクエスト例

レスポンス例

レスポンスフィールド

エラーコード

注意事項

関連