Markdown 업로드 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

Markdown 업로드는 프로젝트에 업로드된 파일로, 이슈, 병합 요청, 스니펫 또는 위키 페이지의 Markdown 텍스트에서 참조될 수 있습니다.

파일 업로드

GitLab 15.10에서 일반적으로 사용 가능합니다. 기능 플래그 enforce_max_attachment_size_upload_api가 제거되었습니다.
full_path 응답 속성 패턴이 GitLab 17.1에서 변경되었습니다.
id 속성이 GitLab 17.3에서 도입되었습니다.

지정된 프로젝트에 파일을 업로드하여 이슈 또는 병합 요청 설명 또는 댓글에서 사용합니다.

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 형식이 사용될 때 확장됩니다.

업로드 목록

GitLab 17.2에서 도입되었습니다.

프로젝트의 모든 업로드를 created_at을 내림차순으로 정렬하여 가져옵니다.

필수 사항:

적어도 Maintainer 역할.

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별 업로드된 파일 다운로드

GitLab 17.2에서 도입되었습니다.

ID별로 업로드된 파일을 다운로드합니다.

필수 사항:

적어도 Maintainer 역할.

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"

시크릿 및 파일 이름으로 업로드된 파일 다운로드

GitLab 17.4에서 도입되었습니다.

시크릿 및 파일 이름으로 업로드된 파일을 다운로드합니다.

필수 사항:

적어도 Guest 역할.

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로 업로드된 파일 삭제

소개됨 GitLab 17.2에서.

ID로 업로드된 파일을 삭제합니다.

전제 조건:

적어도 Maintainer 역할.

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"

비밀 및 파일 이름으로 업로드된 파일 삭제

소개됨 GitLab 17.4에서.

비밀과 파일 이름으로 업로드된 파일을 삭제합니다.

전제 조건:

적어도 Maintainer 역할.

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"

Markdown 업로드 API

파일 업로드

업로드 목록

ID별 업로드된 파일 다운로드

시크릿 및 파일 이름으로 업로드된 파일 다운로드

ID로 업로드된 파일 삭제

비밀 및 파일 이름으로 업로드된 파일 삭제

도움말

기능 사용 가능성과 제품 평가판

도움받기