メインコンテンツへスキップ
GET /api/v1/cloud/environments 現在のアカウント配下の Environment をカーソルページネーション付きで一覧表示します。デフォルトではアーカイブ済みの Environment は含まれません。

リクエストヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT>

クエリパラメータ

パラメータ必須デフォルト説明
limitintegerいいえ201 ページあたりの取得件数。範囲は 1〜100。100 を超える値は 400 invalid_request_error を返す
pagestringいいえ-前回レスポンスの next_page で返されたカーソル
include_archivedbooleanいいえfalsetrue に設定するとアーカイブ済み Environment も含める
created_at[gte]stringいいえ-この RFC 3339 タイムスタンプ以降に作成された Environment のみ返す
created_at[lte]stringいいえ-この RFC 3339 タイムスタンプ以前に作成された Environment のみ返す
ページネーションの詳細はページネーションを参照してください。

リクエスト例

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

レスポンス例

HTTP 200 OK
{
  "data": [
    {
      "id": "env_019e3bb39b6774d8878cd0b9d237574b",
      "type": "environment",
      "name": "doc-test-env",
      "description": "",
      "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:07.017808Z"
    },
    {
      "id": "env_019e2590d33f711fabf42f2857cecd8a",
      "type": "environment",
      "name": "default",
      "description": "",
      "config": {
        "type": "cloud",
        "networking": {
          "type": "limited",
          "allowed_hosts": [],
          "allow_package_managers": false,
          "allow_mcp_servers": false
        },
        "packages": {
          "type": "packages",
          "apt": [],
          "npm": [],
          "pip": []
        }
      },
      "metadata": {},
      "archived_at": null,
      "created_at": "2026-05-14T08:18:28.800813Z",
      "updated_at": "2026-05-14T08:18:28.800813Z"
    }
  ],
  "first_id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "has_more": false,
  "last_id": "env_019e2590d33f711fabf42f2857cecd8a",
  "next_page": null
}

レスポンスフィールド

フィールド説明
dataEnvironment オブジェクトの配列現在のページの Environment
first_idstring現在のページの最初のレコードの ID
last_idstring現在のページの最後のレコードの ID
has_morebooleanさらにページがあるかどうか
next_pagestring|null次のページのカーソル。has_more が true の場合は last_id に等しく、それ以外は null

エラーコード

HTTPtype説明
400invalid_request_errorlimit が正の整数でない
400invalid_request_errorページネーションカーソルが不正
400invalid_request_errorcreated_at[gte] または created_at[lte] が RFC 3339 形式でない
401authentication_error認証失敗、PAT が無効または期限切れ
403permission_errorこのリソースへのアクセス権限がない

注意事項

  • デフォルトでは ID の降順で返されます。
  • アーカイブ済みの Environment はデフォルトの一覧には含まれません。include_archived=true を指定すると含めることができます。
  • カーソルベースのページネーションを使用しており、オフセット方式はサポートされていません。

関連

クラウド環境

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