Group Markdown uploads API

{{< details >}}

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

{{< /details >}}

Use this API to manage Markdown uploads that can be referenced in Markdown text in epics or wiki pages.

List all uploads for a group

{{< history >}}

• Introduced in GitLab 17.2.

{{< /history >}}

Lists all uploads for a specified group sorted by created_at in descending order.

You must have the Maintainer or Owner role to use this endpoint.

GET /groups/:id/uploads

Example request:

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

Example response:

[
  {
    "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
  }
]

Download an uploaded file by ID

{{< history >}}

• Introduced in GitLab 17.2.

{{< /history >}}

Downloads an uploaded file with the specified ID. You must have the Maintainer or Owner role to use this endpoint.

GET /groups/:id/uploads/:upload_id

Supported attributes:

Example request:

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

If successful, returns 200 and the uploaded file in the response body.

Download an uploaded file by secret and filename

{{< history >}}

• Introduced in GitLab 17.4.

{{< /history >}}

Downloads an uploaded file with the specified secret and filename. You must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role to use this endpoint.

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

Supported attributes:

Example request:

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

If successful, returns 200 and the uploaded file in the response body.

Delete an uploaded file by ID

{{< history >}}

• Introduced in GitLab 17.2.

{{< /history >}}

Deletes an uploaded file with the specified ID. You must have the Maintainer or Owner role to use this endpoint.

DELETE /groups/:id/uploads/:upload_id

Supported attributes:

Example request:

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

If successful, returns 204 status code without any response body.

Delete an uploaded file by secret and filename

{{< history >}}

• Introduced in GitLab 17.4.

{{< /history >}}

Deletes an uploaded file with the specified secret and filename. You must have the Maintainer or Owner role to use this endpoint.

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

Supported attributes:

Example request:

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

If successful, returns 204 status code without any response body.