コンテンツにスキップ

backlog api

backlog api <endpoint> [flags]

Backlog API に対して認証済みのリクエストを送信します。任意のエンドポイントにアクセスできます。

<endpoint> <string>
API パス(例: /api/v2/users/myself
-X, --method <string> (default “GET”)
HTTP メソッド
-f, --field <string>
リクエストフィールド(key=value、繰り返し可)
-H, --header <string>
追加ヘッダー(繰り返し可)
-i, --include
レスポンスヘッダーを含める
--paginate
ページネーションで全件取得
--silent
出力を抑制

--field で指定した値は自動的に型変換されます。

  • key=123 → 数値
  • key=true / key=false → 真偽値
  • key=text → 文字列
Terminal window
# 自分のユーザー情報を取得
backlog api /api/v2/users/myself
# 課題を作成
backlog api /api/v2/issues -X POST \
-f projectId=12345 \
-f summary="新しい課題" \
-f issueTypeId=67890 \
-f priorityId=3
# ページネーションで全件取得
backlog api /api/v2/issues --paginate
# レスポンスヘッダーを表示
backlog api /api/v2/space -i