MarkdownアップロードAPI

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

このAPIを使用して、イシュー、マージリクエスト、スニペット、またはWikiページでMarkdownテキストで参照できる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"