グループMarkdownアップロードAPI
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
このAPIを使用して、エピックまたはWikiページでMarkdownテキストとして参照できるMarkdownアップロードを管理します。
ファイルをグループにアップロードする
指定されたグループにファイルをアップロードします。ファイルへのMarkdown形式のリンクを返します。
このエンドポイントを使用するには、ゲスト、プランナー、レポーター、デベロッパー、メンテナー、またはオーナーロールが必要です。
POST /groups/:id/uploadsサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数または文字列 | はい | グループのIDまたはURLエンコードされたパス。 |
file | ファイル | はい | アップロードするファイル。 |
リクエスト例:
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--form "file=@/path/to/image.png" \
--url "https://gitlab.example.com/api/v4/groups/5/uploads"レスポンス例:
{
"id": 3,
"alt": "image",
"url": "/uploads/648d97c6eef5fc5df8d1004565b3ee5a/image.png",
"full_path": "/-/group/5/uploads/648d97c6eef5fc5df8d1004565b3ee5a/image.png",
"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でアップロード済みファイルをダウンロードする
指定された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でアップロード済みファイルを削除する
指定された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ステータスcodeを返します。
シークレットとファイル名でアップロード済みファイルを削除する
指定されたシークレットとファイル名のアップロード済みファイルを削除します。このエンドポイントを使用するには、メンテナーまたはオーナーロールが必要です。
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ステータスcodeを返します。