正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

ノートAPI

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、GitLabコンテンツに添付されたコメントとシステムレコードを管理します。次のことができます:

  • イシュー、マージリクエスト、エピック、スニペット、およびコミットに対するコメントを作成および変更します。
  • オブジェクト変更に関するシステム生成ノートを取得する。
  • 結果を並べ替えてページ分割します。
  • 機密フラグと内部フラグで表示レベルを制御します。
  • レート制限で不正使用を防止します。

一部のシステム生成ノートは、個別のリソースイベントとして追跡されます。

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。詳細については、ページネーションを参照してください。

リソースイベント

一部のシステムノートはこのAPIの一部ではありませんが、個別のイベントとして記録されます。

ノートのページネーション

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。

詳細については、ページネーションを参照してください。

レート制限

不正使用を回避するため、ユーザーが1分あたりに実行できるCreateリクエストの数を制限できます。詳細については、ノート作成のレート制限を参照してください。

イシュー

すべてのイシューノートをリスト表示

指定されたイシューのすべてのノートをリスト表示します。

GET /projects/:id/issues/:issue_iid/notes
GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at
GET /projects/:id/issues/:issue_iid/notes?activity_filter=only_comments
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
issue_iid整数はいイシューのIID
activity_filter文字列いいえアクティビティタイプでノートをフィルタリングします。有効な値: all_notes、only_comments、only_activity。デフォルトはall_notesです。
sort文字列いいえascまたはdescの順にソートされたイシューノートを返します。デフォルトはdescです。
order_by文字列いいえcreated_atフィールドまたはupdated_atフィールドで順序付けられたイシューノートを返します。デフォルトはcreated_atです。
[
  {
    "id": 302,
    "body": "closed",
    "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
    },
    "created_at": "2013-10-02T09:22:45Z",
    "updated_at": "2013-10-02T10:22:45Z",
    "system": true,
    "noteable_id": 377,
    "noteable_type": "Issue",
    "project_id": 5,
    "noteable_iid": 377,
    "resolvable": false,
    "confidential": false,
    "internal": false,
    "imported": false,
    "imported_from": "none"
  },
  {
    "id": 305,
    "body": "Text of the comment\r\n",
    "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
    },
    "created_at": "2013-10-02T09:56:03Z",
    "updated_at": "2013-10-02T09:56:03Z",
    "system": true,
    "noteable_id": 121,
    "noteable_type": "Issue",
    "project_id": 5,
    "noteable_iid": 121,
    "resolvable": false,
    "confidential": true,
    "internal": true,
    "imported": false,
    "imported_from": "none"
  }
]
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes"

イシューノートを取得する

プロジェクトのイシューに対する指定されたノートを取得する。

GET /projects/:id/issues/:issue_iid/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
issue_iid整数はいプロジェクトイシューのIID
note_id整数はいイシューノートのID
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1"

イシューノートを作成する

指定されたプロジェクトのイシューに対するノートを作成します。

POST /projects/:id/issues/:issue_iid/notes

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数はいイシューのIID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
confidentialブール値いいえ非推奨: GitLab 16.0で削除され、internalに名称変更される予定です。ノートの非公開フラグ。デフォルトはfalseです。
internalブール値いいえノートの内部フラグ。両方のパラメータが送信された場合、confidentialを上書きします。デフォルトはfalseです。
created_at文字列いいえ日時文字列（ISO 8601形式）。1970-01-01以降である必要があります。例: 2016-03-11T03:45:40Z（管理者権限またはプロジェクト/グループオーナー権限が必要です）
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note"

イシューノートを更新する

イシューの指定されたノートを更新します。

PUT /projects/:id/issues/:issue_iid/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
issue_iid整数はいイシューのIID
note_id整数はいノートのID。
body文字列いいえノートのコンテンツ。1,000,000文字に制限されています。
confidentialブール値いいえ非推奨: GitLab 16.0で削除される予定です。ノートの非公開フラグ。デフォルトはfalseです。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636?body=note"

イシューノートを削除する

イシューの既存のノートを削除します。

DELETE /projects/:id/issues/:issue_iid/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
issue_iid整数はいイシューのIID
note_id整数はいノートのID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636"

スニペット

スニペットノートAPIは、プロジェクトレベルのスニペットを対象としており、パーソナルスニペットを対象としていません。

すべてのスニペットノートをリストする

指定されたスニペットのすべてのノートをリスト表示します。スニペットノートは、ユーザーがスニペットに投稿できるコメントです。

GET /projects/:id/snippets/:snippet_id/notes
GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
snippet_id整数はいプロジェクトスニペットのID
sort文字列いいえascまたはdescの順にソートされたスニペットノートを返します。デフォルトはdescです。
order_by文字列いいえcreated_atフィールドまたはupdated_atフィールドで順序付けられたスニペットノートを返します。デフォルトはcreated_atです。
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes"

スニペットノートを取得する

スニペットの指定されたノートを取得する。

GET /projects/:id/snippets/:snippet_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
snippet_id整数はいプロジェクトスニペットのID
note_id整数はいスニペットノートのID
{
  "id": 302,
  "body": "closed",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
  },
  "created_at": "2013-10-02T09:22:45Z",
  "updated_at": "2013-10-02T10:22:45Z",
  "system": true,
  "noteable_id": 377,
  "noteable_type": "Issue",
  "project_id": 5,
  "noteable_iid": 377,
  "resolvable": false,
  "confidential": false,
  "internal": false,
  "imported": false,
  "imported_from": "none"
}
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11"

スニペットノートを作成する

指定されたスニペットに対して新しいノートを作成します。スニペットノートは、スニペットに対するユーザーコメントです。本文に絵文字リアクションのみが含まれるノートを作成すると、GitLabはこのオブジェクトを返します。

POST /projects/:id/snippets/:snippet_id/notes

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
snippet_id整数はいスニペットのID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
created_at文字列いいえ日時文字列（ISO 8601形式）。例: 2016-03-11T03:45:40Z（管理者権限またはプロジェクト/グループオーナー権限が必要です）
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note"

スニペットノートを更新する

スニペットの指定されたノートを更新します。

PUT /projects/:id/snippets/:snippet_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
snippet_id整数はいスニペットのID
note_id整数はいスニペットノートのID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/1659?body=note"

スニペットノートを削除する

スニペットの既存のノートを削除します。

DELETE /projects/:id/snippets/:snippet_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
snippet_id整数はいスニペットのID
note_id整数はいノートのID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/52/notes/1659"

マージリクエスト

すべてのマージリクエストノートをリストする

指定されたマージリクエストのすべてのノートをリスト表示します。

GET /projects/:id/merge_requests/:merge_request_iid/notes
GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=updated_at
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数はいプロジェクトマージリクエストのIID
sort文字列いいえascまたはdescの順にソートされたマージリクエストノートを返します。デフォルトはdescです。
order_by文字列いいえcreated_atフィールドまたはupdated_atフィールドで順序付けられたマージリクエストノートを返します。デフォルトはcreated_atです。
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes"

マージリクエストノートを取得する

マージリクエストの指定されたノートを取得する。

GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数はいプロジェクトマージリクエストのIID
note_id整数はいマージリクエストノートのID
{
  "id": 301,
  "body": "Comment for MR",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
  },
  "created_at": "2013-10-02T08:57:14Z",
  "updated_at": "2013-10-02T08:57:14Z",
  "system": false,
  "noteable_id": 2,
  "noteable_type": "MergeRequest",
  "project_id": 5,
  "noteable_iid": 2,
  "resolvable": false,
  "confidential": false,
  "internal": false
}
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1"

マージリクエストノートを作成する

指定されたマージリクエストに対してノートを作成します。ノートは、マージリクエスト内の特定の行にアタッチされません。より詳細な制御を行う他のアプローチについては、コミットAPIのコミットへのコメント投稿 、およびディスカッションAPIのマージリクエスト差分で新しいスレッドを作成するを参照してください。

本文に絵文字リアクションのみが含まれるノートを作成すると、GitLabはこのオブジェクトを返します。

POST /projects/:id/merge_requests/:merge_request_iid/notes

パラメータは以下のとおりです:

属性型必須説明
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数はいプロジェクトマージリクエストのIID
created_at文字列いいえ日時文字列（ISO 8601形式）。例: 2016-03-11T03:45:40Z（管理者権限またはプロジェクト/グループオーナー権限が必要です）
internalブール値いいえノートの内部フラグ。デフォルトはfalseです。
merge_request_diff_head_sha文字列いいえ/mergeクイックアクションに必要です。ヘッドコミットのSHA。APIリクエストの送信後にマージリクエストが更新されないようにします。
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes?body=note"

マージリクエストノートを更新する

マージリクエストの指定されたノートを更新します。

PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数はいプロジェクトマージリクエストのIID
note_id整数いいえノートのID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
confidentialブール値いいえ非推奨: GitLab 16.0で削除される予定です。ノートの非公開フラグ。デフォルトはfalseです。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1?body=note"

マージリクエストノートを削除する

マージリクエストの既存のノートを削除します。

DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数はいマージリクエストのIID
note_id整数はいノートのID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602"

エピック

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

エピックREST APIは、GitLab 17.0で非推奨になり、APIのv5で削除される予定です。GitLab 17.4から18.0までのバージョンで、エピックの新しい外観が有効になっている場合は、GitLab 18.1以降で、代わりに作業アイテムAPIを使用してください。詳細については、作業アイテムにエピックAPIを移行するを参照してください。これは破壊的な変更です。

すべてのエピックノートをリストする

指定されたエピックのすべてのノートをリスト表示します。エピックノートは、ユーザーがエピックに投稿できるコメントです。

エピックノートAPIは、エピックIDをエピックIIDの代わりに使用します。エピックのIIDを使用すると、GitLabは、404エラー、または間違ったエピックのノートを返します。イシューノートAPIやマージリクエストノートAPIとは異なります。

GET /groups/:id/epics/:epic_id/notes
GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
epic_id整数はいグループエピックのID
sort文字列いいえascまたはdescの順にソートされたエピックノートを返します。デフォルトはdescです。
order_by文字列いいえcreated_atフィールドまたはupdated_atフィールドで順序付けられたエピックノートを返します。デフォルトはcreated_atです。
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes"

エピックノートを取得する

エピックの指定されたノートを取得する。

GET /groups/:id/epics/:epic_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
epic_id整数はいエピックのID
note_id整数はいノートのID
{
  "id": 302,
  "body": "Epic note",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
  },
  "created_at": "2013-10-02T09:22:45Z",
  "updated_at": "2013-10-02T10:22:45Z",
  "system": true,
  "noteable_id": 11,
  "noteable_type": "Epic",
  "project_id": 5,
  "noteable_iid": 11,
  "resolvable": false,
  "confidential": false,
  "internal": false,
  "imported": false,
  "imported_from": "none"
}
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1"

エピックノートを作成する

指定されたエピックに対してノートを作成します。エピックノートは、ユーザーがエピックに投稿できるコメントです。本文に絵文字リアクションのみが含まれるノートを作成すると、GitLabはこのオブジェクトを返します。

POST /groups/:id/epics/:epic_id/notes

パラメータは以下のとおりです:

属性型必須説明
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
epic_id整数はいエピックのID
id整数または文字列はいグループのIDまたはURLエンコードされたパス
confidentialブール値いいえ非推奨: GitLab 16.0で削除され、internalに名称変更される予定です。ノートの非公開フラグ。デフォルトはfalseです。
internalブール値いいえノートの内部フラグ。両方のパラメータが送信された場合、confidentialを上書きします。デフォルトはfalseです。
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes?body=note"

エピックノートを更新する

エピックの指定されたノートを更新します。

PUT /groups/:id/epics/:epic_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
epic_id整数はいエピックのID
note_id整数はいノートのID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
confidentialブール値いいえ非推奨: GitLab 16.0で削除される予定です。ノートの非公開フラグ。デフォルトはfalseです。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1?body=note"

エピックノートを削除する

エピックの既存のノートを削除します。

DELETE /groups/:id/epics/:epic_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
epic_id整数はいエピックのID
note_id整数はいノートのID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659"

プロジェクトWiki

すべてのプロジェクトWikiノートをリストする

指定されたプロジェクトWikiページのすべてのノートをリスト表示します。プロジェクトWikiノートは、ユーザーがWikiページに投稿できるコメントです。

WikiページノートAPIは、Wikiページslugの代わりにWikiページmeta IDを使用します。ページのslugを使用している場合は、GitLabは404エラーを返します。メタIDはプロジェクトWiki APIから取得できます。

GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes?sort=asc&order_by=updated_at

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
sort文字列いいえascまたはdescの順にソートされたWikiページノートを返します。デフォルトはdescです。
order_by文字列いいえcreated_atフィールドまたはupdated_atフィールドで順序付けられたWikiページノートを返します。デフォルトはcreated_atです。
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes"

Wikiページノートを取得する

指定されたWikiページの単一のノートを取得する。

GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
note_id整数はいノートのID
{
  "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
  },
  "body": "foobar",
  "commands_changes": {},
  "confidential": false,
  "created_at": "2025-03-11T11:36:32.222Z",
  "id": 1218,
  "imported": false,
  "imported_from": "none",
  "internal": false,
  "noteable_id": 35,
  "noteable_iid": null,
  "noteable_type": "WikiPage::Meta",
  "project_id": 5,
  "resolvable": false,
  "system": false,
  "type": null,
  "updated_at": "2025-03-11T11:36:32.222Z"
}
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218"

Wikiページノートを作成する

単一のWikiページの新しいノートを作成します。Wikiページノートは、ユーザーがWikiページに投稿できるコメントです。

POST /projects/:id/wiki_pages/:wiki_page_meta_id/notes

パラメータは以下のとおりです:

属性型必須説明
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
wiki_page_meta_id整数はいWikiページのメタID
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes?body=note"

Wikiページノートを更新する

Wikiページの既存のノートを更新します。

PUT /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
note_id整数はいノートのID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218?body=note"

Wikiページノートを削除する

Wikiページからノートを削除します。

DELETE /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
note_id整数はいノートのID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218"

グループWiki

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

グループWikiノートをリスト表示

指定されたグループWikiページのすべてのノートをリスト表示します。グループWikiノートは、ユーザーがWikiページに投稿できるコメントです。

WikiページノートAPIは、Wikiページslugの代わりにWikiページmeta IDを使用します。ページのslugを使用している場合は、GitLabは404エラーを返します。メタIDはグループWiki APIから取得できます。

GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes?sort=asc&order_by=updated_at
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
sort文字列いいえascまたはdescの順にソートされたWikiページノートを返します。デフォルトはdescです。
order_by文字列いいえcreated_atフィールドまたはupdated_atフィールドで順序付けられたWikiページノートを返します。デフォルトはcreated_atです。
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes"

Wikiページノートを取得する

Wikiページの指定されたノートを取得する。

GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
note_id整数はいノートのID
{
  "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
  },
  "body": "foobar",
  "commands_changes": {},
  "confidential": false,
  "created_at": "2025-03-11T11:36:32.222Z",
  "id": 1218,
  "imported": false,
  "imported_from": "none",
  "internal": false,
  "noteable_id": 35,
  "noteable_iid": null,
  "noteable_type": "WikiPage::Meta",
  "project_id": null,
  "resolvable": false,
  "system": false,
  "type": null,
  "updated_at": "2025-03-11T11:36:32.222Z"
}
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218"

Wikiページノートを作成する

指定されたWikiページに対してノートを作成します。Wikiページノートは、ユーザーがWikiページに投稿できるコメントです。

POST /groups/:id/wiki_pages/:wiki_page_meta_id/notes

パラメータは以下のとおりです:

属性型必須説明
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
wiki_page_meta_id整数はいWikiページのメタID
id整数または文字列はいグループのIDまたはURLエンコードされたパス
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes?body=note"

Wikiページノートを更新する

Wikiページの指定されたノートを更新します。

PUT /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
note_id整数はいノートのID
body文字列はいノートのコンテンツ。1,000,000文字に制限されています。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218?body=note"

Wikiページノートを削除する

Wikiページからノートを削除します。

DELETE /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id

パラメータは以下のとおりです:

属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
wiki_page_meta_id整数はいWikiページのメタID
note_id整数はいノートのID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218"