グループMarkdownアップロードAPI

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

Markdownアップロードは、グループにアップロードされたファイルで、エピックまたはWikiページのMarkdownテキストで参照できます。

アップロードをリストします

グループのすべてのアップロードを降順でcreated_atでソートして取得します。

このエンドポイントを使用するには、少なくともメンテナーの役割が必要です。

GET /groups/:id/uploads

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/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でアップロードされたファイルをダウンロードします

このエンドポイントを使用するには、少なくともメンテナーの役割が必要です。

GET /groups/:id/uploads/:upload_id

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

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス。
`upload_id`	整数	はい	アップロードのID。

リクエスト例:

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

成功した場合、200と、アップロードされたファイルがレスポンスボディで返されます。

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

このエンドポイントを使用するには、少なくともゲストロールが必要です。

GET /groups/:id/uploads/:secret/:filename

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

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

リクエスト例:

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

成功した場合、200と、アップロードされたファイルがレスポンスボディで返されます。

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

このエンドポイントを使用するには、少なくともメンテナーの役割が必要です。

DELETE /groups/:id/uploads/:upload_id

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

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス。
`upload_id`	整数	はい	アップロードのID。

リクエスト例:

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

成功した場合、レスポンスボディなしで204ステータスコードが返されます。

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

このエンドポイントを使用するには、少なくともメンテナーの役割が必要です。

DELETE /groups/:id/uploads/:secret/:filename

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

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

リクエスト例:

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

成功した場合、レスポンスボディなしで204ステータスコードが返されます。