Skip to main content
Deployments

Deployment 一覧

現在のアカウント配下の Deployment 一覧をカーソルページネーション付きで取得します。

GET /api/v1/cloud/deployments 現在のアカウント配下のすべての Deployment をカーソルページネーション付きで取得します。結果は作成時刻の降順(新しい順)でソートされます。アーカイブ済み Deployment はデフォルトで除外されます。

ヘッダー

名称必須
AuthorizationはいBearer $QODER_ACCESS_TOKEN

クエリパラメータ

パラメータ必須説明
limitintegerいいえ返却件数の上限。デフォルト 20、範囲は 1〜100。100 を超える値は 400 invalid_request_error を返します。
pagestringいいえnext_page が返すカーソル値。before_idafter_id と併用しないでください。
after_idstringいいえカーソルページネーション: この ID 以降のレコードを返す
before_idstringいいえカーソルページネーション: この ID 以前のレコードを返す
statusstringいいえステータスでフィルタリング: activepaused
include_archivedbooleanいいえアーカイブ済み Deployment を含める。デフォルトは false
agent_idstringいいえAgent ID でフィルタリング
created_at[gte]stringいいえこの RFC3339 タイムスタンプ以降に作成された Deployment を返す
created_at[lte]stringいいえこの RFC3339 タイムスタンプ以前に作成された Deployment を返す

リクエスト例

curl -X GET "https://api.qoder.com/api/v1/cloud/deployments?limit=2" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

レスポンス例

HTTP 200 OK
{
  "data": [
    {
      "agent": {
        "id": "agent_019eb4d4a06d747c865d5800b9c57ae2",
        "type": "agent",
        "version": 1
      },
      "archived_at": null,
      "created_at": "2026-06-14T08:53:32Z",
      "description": "Deployment created for API documentation verification",
      "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
      "environment_variables": "",
      "id": "dep_019ec556114c78f8b60ee34fcb98bf59",
      "initial_events": [
        {
          "content": [
            {
              "type": "text",
              "text": "Generate today's status report"
            }
          ],
          "type": "user.message"
        }
      ],
      "metadata": {},
      "name": "api-doc-verification-deployment",
      "paused_reason": null,
      "resources": [],
      "schedule": {
        "expression": "0 9 * * *",
        "timezone": "Asia/Shanghai",
        "type": "cron",
        "upcoming_runs_at": [
          "2026-06-15T01:00:00Z",
          "2026-06-16T01:00:00Z",
          "2026-06-17T01:00:00Z",
          "2026-06-18T01:00:00Z",
          "2026-06-19T01:00:00Z"
        ]
      },
      "status": "active",
      "type": "deployment",
      "updated_at": "2026-06-14T08:53:32Z",
      "vault_ids": []
    }
  ],
  "first_id": "dep_019ec556114c78f8b60ee34fcb98bf59",
  "has_more": true,
  "last_id": "dep_019ec51604b87aaea12568c9ab7b7025",
  "next_page": "dep_019ec51604b87aaea12568c9ab7b7025"
}

レスポンスフィールド

フィールド説明
dataarrayDeployment オブジェクトの配列
first_idstring現在ページ先頭レコードの ID
last_idstring現在ページ末尾レコードの ID
has_morebooleanさらにレコードがあるかどうか
next_pagestring or null次ページのカーソル値(has_more が true のときは last_id と同じ、それ以外は null)
next_page を次回リクエストの page パラメータとして使用すると、後方ページネーションを実現できます。

エラー

HTTPtype説明
401authentication_errorPAT または SAT が無効または期限切れ
完全なエラーエンベロープについては エラー を参照してください。

関連項目

Deployment 一覧 - Qoder