GET /v1/deployments
現在のアカウント配下のすべての Deployment をカーソルページネーション付きで取得します。結果は作成時刻の降順(新しい順)でソートされます。アーカイブ済み Deployment はデフォルトで除外されます。
ヘッダー
| 名称 | 必須 | 値 |
|---|---|---|
Authorization | はい | Bearer $QODER_PAT |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | 返却件数の上限。デフォルト 20、最大 1000。 |
after_id | string | いいえ | カーソルページネーション: この ID 以降のレコードを返す |
before_id | string | いいえ | カーソルページネーション: この ID 以前のレコードを返す |
status | string | いいえ | ステータスでフィルタリング: active、paused |
include_archived | boolean | いいえ | アーカイブ済み Deployment を含める。デフォルトは false。 |
agent_id | string | いいえ | Agent ID でフィルタリング |
リクエスト例
レスポンス例
HTTP 200 OKレスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | array | Deployment オブジェクトの配列 |
first_id | string | 現在ページ先頭レコードの ID |
last_id | string | 現在ページ末尾レコードの ID |
has_more | boolean | さらにレコードがあるかどうか |
next_page | string or null | 次ページのカーソル値(has_more が true のときは last_id と同じ、それ以外は null) |
last_id を次回リクエストの after_id パラメータとして使用すると、後方ページネーションを実現できます。
エラー
| HTTP | type | 説明 |
|---|---|---|
| 401 | authentication_error | PAT が無効または期限切れ |
関連項目
Deployment の作成
Agent を cron スケジュールにバインドした新しい Deployment を作成します。
Deployment の取得
ID を指定して単一の Deployment 詳細を取得します。
全 Deployment Run 一覧
すべての Deployment にまたがる実行履歴を確認します。
エラー
共通のエラーエンベロープ仕様を参照します。