그룹 Markdown 업로드 API
GitLab v19.5Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
요약
이 API를 사용하면 에픽이나 위키 페이지의 Markdown 텍스트에서 참조할 수 있는 Markdown 업로드를 관리합니다. 지정한 그룹에 파일을 업로드합니다. 이 엔드포인트를 사용하려면 Guest, Planner, Reporter, Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
이 API를 사용하면 에픽이나 위키 페이지의 Markdown 텍스트에서 참조할 수 있는 Markdown 업로드를 관리합니다.
그룹에 파일 업로드#
히스토리
- GitLab 19.0에서 도입되었습니다.
지정한 그룹에 파일을 업로드합니다. 해당 파일을 가리키는 Markdown 형식 링크를 반환합니다.
이 엔드포인트를 사용하려면 Guest, Planner, Reporter, Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
POST /groups/:id/uploads
지원하는 속성은 다음과 같습니다.
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 그룹의 ID 또는 URL 인코딩된 경로입니다. |
file |
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": ""
}
그룹의 모든 업로드 목록 조회#
히스토리
- GitLab 17.2에서 도입되었습니다.
지정한 그룹의 모든 업로드를 created_at 기준 내림차순으로 정렬해 조회합니다.
이 엔드포인트를 사용하려면 Maintainer 또는 Owner 권한이 있어야 합니다.
GET /groups/:id/uploads
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 그룹의 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로 업로드된 파일 다운로드#
히스토리
- GitLab 17.2에서 도입되었습니다.
지정한 ID의 업로드 파일을 내려받습니다. 이 엔드포인트를 사용하려면 Maintainer 또는 Owner 권한이 있어야 합니다.
GET /groups/:id/uploads/:upload_id
지원하는 속성은 다음과 같습니다.
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 그룹의 ID 또는 URL 인코딩된 경로입니다. |
upload_id |
integer | 예 | 업로드의 ID 입니다. |
요청 예시:
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/uploads/1"
성공하면 200과 함께 응답 본문에 업로드 파일을 반환합니다.
시크릿 및 파일명으로 업로드된 파일 다운로드#
히스토리
- GitLab 17.4에서 도입되었습니다.
지정한 시크릿과 파일 이름에 해당하는 업로드 파일을 내려받습니다. 이 엔드포인트를 사용하려면 Guest, Planner, Reporter, Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
GET /groups/:id/uploads/:secret/:filename
지원하는 속성은 다음과 같습니다.
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 그룹의 ID 또는 URL 인코딩된 경로입니다. |
secret |
string | 예 | 업로드의 32자 시크릿입니다. |
filename |
string | 예 | 업로드의 파일 이름입니다. |
요청 예시:
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/uploads/648d97c6eef5fc5df8d1004565b3ee5a/sample.jpg"
성공하면 200과 함께 응답 본문에 업로드 파일을 반환합니다.
ID로 업로드된 파일 삭제#
히스토리
- GitLab 17.2에서 도입되었습니다.
지정한 ID의 업로드 파일을 삭제합니다. 이 엔드포인트를 사용하려면 Maintainer 또는 Owner 권한이 있어야 합니다.
DELETE /groups/:id/uploads/:upload_id
지원하는 속성은 다음과 같습니다.
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 그룹의 ID 또는 URL 인코딩된 경로입니다. |
upload_id |
integer | 예 | 업로드의 ID 입니다. |
요청 예시:
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/uploads/1"
성공하면 응답 본문 없이 204 상태 코드를 반환합니다.
시크릿 및 파일명으로 업로드된 파일 삭제#
히스토리
- GitLab 17.4에서 도입되었습니다.
지정한 시크릿과 파일 이름에 해당하는 업로드 파일을 삭제합니다. 이 엔드포인트를 사용하려면 Maintainer 또는 Owner 권한이 있어야 합니다.
DELETE /groups/:id/uploads/:secret/:filename
지원하는 속성은 다음과 같습니다.
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
integer or string | 예 | 그룹의 ID 또는 URL 인코딩된 경로입니다. |
secret |
string | 예 | 업로드의 32자 시크릿입니다. |
filename |
string | 예 | 업로드의 파일 이름입니다. |
요청 예시:
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/uploads/648d97c6eef5fc5df8d1004565b3ee5a/sample.jpg"
성공하면 응답 본문 없이 204 상태 코드를 반환합니다.