MarkdownアップロードAPI

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

このAPIを使用して、Markdownのアップロードを管理し、イシュー、マージリクエスト、スニペット、またはWikiページでMarkdownテキストで参照できるようにします。

ファイルをアップロードする

イシューまたはマージリクエストの説明、あるいはコメントで使用するために、指定されたプロジェクトにファイルをアップロードします。

POST /projects/:id/uploads

サポートされている属性は以下のとおりです:

属性	種類	必須	説明
`file`	文字列	はい	アップロードするファイル。
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。

ファイルシステムからファイルをアップロードするには、--form引数を使用します。これにより、cURLはContent-Type: multipart/form-dataヘッダーを使用してデータを送信します。file=パラメータは、ファイルシステムのファイルを指しており、先頭に@を付ける必要があります。

リクエスト例:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --form "file=@dk.png" "https://gitlab.example.com/api/v4/projects/5/uploads"

レスポンス例:

{
  "id": 5,
  "alt": "dk",
  "url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
  "full_path": "/-/project/1234/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
  "markdown": "![dk](/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png)"
}

応答では、以下が表示されます:

full_pathは、ファイルへの絶対パスです。
urlは、Markdownコンテキストで使用できます。markdownの形式を使用すると、リンクが展開されます。

アップロードの一覧表示

プロジェクトのすべてのアップロードをcreated_atで降順にソートして取得します。

前提要件:

メンテナー以上のロール。

GET /projects/:id/uploads

サポートされている属性は以下のとおりです:

属性	種類	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/uploads"

レスポンス例:

[
  {
    "id": 1,
    "size": 1024,
    "filename": "image.png",
    "created_at":"2024-06-20T15:53:03.067Z",
    "uploaded_by": {
      "id": 18,
      "name" : "Alexandra Bashirian",
      "username" : "eileen.lowe"
    }
  },
  {
    "id": 2,
    "size": 512,
    "filename": "other-image.png",
    "created_at":"2024-06-19T15:53:03.067Z",
    "uploaded_by": null
  }
]

IDによるアップロードファイルのダウンロード

IDでアップロードされたファイルをダウンロードします。

前提要件:

メンテナー以上のロール。

GET /projects/:id/uploads/:upload_id

サポートされている属性は以下のとおりです:

属性	種類	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`upload_id`	整数	はい	アップロードのID。

成功すると、200と、応答本文にアップロードされたファイルが返されます。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/uploads/1"

シークレットとファイル名によるアップロードファイルのダウンロード

シークレットとファイル名でアップロードされたファイルをダウンロードします。

前提要件:

ゲストロール以上が必要です。

GET /projects/:id/uploads/:secret/:filename

サポートされている属性は以下のとおりです:

属性	種類	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`secret`	文字列	はい	アップロードの32文字のシークレット。
`filename`	文字列	はい	アップロードのファイル名。

成功すると、200と、応答本文にアップロードされたファイルが返されます。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/uploads/648d97c6eef5fc5df8d1004565b3ee5a/sample.jpg"

IDによるアップロードファイルの削除

IDでアップロードされたファイルを削除します。

前提要件:

メンテナー以上のロール。

DELETE /projects/:id/uploads/:upload_id

サポートされている属性は以下のとおりです:

属性	種類	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`upload_id`	整数	はい	アップロードのID。

成功すると、応答本文なしで204ステータスコードが返されます。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/uploads/1"

シークレットとファイル名によるアップロードファイルの削除

シークレットとファイル名でアップロードされたファイルを削除します。

前提要件:

メンテナー以上のロール。

DELETE /projects/:id/uploads/:secret/:filename

サポートされている属性は以下のとおりです:

属性	種類	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`secret`	文字列	はい	アップロードの32文字のシークレット。
`filename`	文字列	はい	アップロードのファイル名。

成功すると、応答本文なしで204ステータスコードが返されます。

リクエスト例:

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/uploads/648d97c6eef5fc5df8d1004565b3ee5a/sample.jpg"