Backlogの認証で、APIキーをリクエストヘッダーで送信できるようになりました

こんにちは、Backlog開発チームです。いつもBacklogをご利用いただき、ありがとうございます。

このたび、Backlog APIのAPIキーをリクエストヘッダーで送信できるようになりました。従来のクエリパラメーターに加えて、より安全な送信方法を選べます。

概要

Backlog APIの認証に使うAPIキーを、リクエストヘッダー「Backlog-API-Key」で送信できるようになりました。従来のクエリパラメーター(?apiKey=)による送信も、引き続きご利用いただけます。対象は全プラン・全スペースです。

リリース日

2026年8月6日(木)

開発の背景

これまでは、クエリパラメーター(?apiKey=)でAPIキーを送信する方式のみに対応していました。この方法では、APIキーがURLの一部に含まれます。そのため、アクセスログやプロキシログ、ブラウザの履歴にキーが残る場合があります。

リクエストヘッダーで送信すると、APIキーはURLに含まれません。その結果、意図しない漏えいのリスクを抑えられます。ヘッダーでの送信は多くのAPIサービスで採用されている方式のため、開発者にとっても扱いやすくなります。

今回のアップデートでできるようになること

  • ヘッダーでのAPIキー送信: リクエストヘッダー「Backlog-API-Key」でAPIキーを送信できます。
  • 漏えいリスクの低減: APIキーがURLに含まれないため、ログや履歴に残りにくくなります。
  • 一般的な認証方式への対応: 多くのAPIサービスと同じヘッダー方式で、開発者が扱いやすくなります。

利用方法

  1. リクエストヘッダーに「Backlog-API-Key」を追加します。
  2. 値にAPIキーを設定して、APIを呼び出します。
GET /api/v2/users/myself
Host: xx.backlog.com
Backlog-API-Key: YOUR_API_KEY

おわりに

今回は、Backlog APIのAPIキーをリクエストヘッダーで送信できるようになったことをお知らせしました。

本機能が、より安全なAPI連携の一助となれば幸いです。

Backlog開発チームは、今後も皆さまの「はたらく」を楽しく、スムーズにするための改善を続けてまいります。

ご不明点やご質問がございましたら、お問い合わせからご連絡ください。

それでは、今日も楽しいBacklogライフを!

チームで使えるプロジェクト・タスク管理ツールならBacklog