API des chargements Markdown de groupe

{{< details >}}

• Édition : Gratuite, GitLab Premium, GitLab Ultimate
• Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

Utilisez cette API pour gérer les chargements Markdown qui peuvent être référencés dans du texte Markdown dans des epics ou des pages wiki.

Charger un fichier vers un groupe {#upload-a-file-to-a-group}

{{< history >}}

• Introduit dans GitLab 19.0.

{{< /history >}}

Charge un fichier vers le groupe spécifié. Renvoie un lien formaté en Markdown vers le fichier.

Vous devez disposer du rôle Invité, Planificateur, Reporter, Developer, Maintainer ou Owner pour utiliser ce point de terminaison.

POST /groups/:id/uploads

Attributs pris en charge :

Exemple de requête :

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"

Exemple de réponse :

{
  "id": 3,
  "alt": "image",
  "url": "/uploads/648d97c6eef5fc5df8d1004565b3ee5a/image.png",
  "full_path": "/-/group/5/uploads/648d97c6eef5fc5df8d1004565b3ee5a/image.png",
  "markdown": "![image](/uploads/648d97c6eef5fc5df8d1004565b3ee5a/image.png)"
}

Lister tous les chargements d'un groupe {#list-all-uploads-for-a-group}

{{< history >}}

• Introduit dans GitLab 17.2.

{{< /history >}}

Liste tous les chargements d'un groupe spécifié, triés par created_at dans l'ordre décroissant.

Vous devez disposer du rôle Maintainer ou Owner pour utiliser ce point de terminaison.

GET /groups/:id/uploads

Exemple de requête :

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

Exemple de réponse :

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

Télécharger un fichier chargé par ID {#download-an-uploaded-file-by-id}

{{< history >}}

• Introduit dans GitLab 17.2.

{{< /history >}}

Télécharge un fichier chargé avec l'ID spécifié. Vous devez disposer du rôle Maintainer ou Owner pour utiliser ce point de terminaison.

GET /groups/:id/uploads/:upload_id

Attributs pris en charge :

Exemple de requête :

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

En cas de succès, renvoie 200 et le fichier chargé dans le corps de la réponse.

Télécharger un fichier chargé par secret et nom de fichier {#download-an-uploaded-file-by-secret-and-filename}

{{< history >}}

• Introduit dans GitLab 17.4.

{{< /history >}}

Télécharge un fichier chargé avec le secret et le nom de fichier spécifiés. Vous devez disposer du rôle Invité, Planificateur, Reporter, Developer, Maintainer ou Owner pour utiliser ce point de terminaison.

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

Attributs pris en charge :

Exemple de requête :

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

En cas de succès, renvoie 200 et le fichier chargé dans le corps de la réponse.

Supprimer un fichier chargé par ID {#delete-an-uploaded-file-by-id}

{{< history >}}

• Introduit dans GitLab 17.2.

{{< /history >}}

Supprime un fichier chargé avec l'ID spécifié. Vous devez disposer du rôle Maintainer ou Owner pour utiliser ce point de terminaison.

DELETE /groups/:id/uploads/:upload_id

Attributs pris en charge :

Exemple de requête :

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

En cas de succès, renvoie le code de statut 204 sans corps de réponse.

Supprimer un fichier chargé par secret et nom de fichier {#delete-an-uploaded-file-by-secret-and-filename}

{{< history >}}

• Introduit dans GitLab 17.4.

{{< /history >}}

Supprime un fichier chargé avec le secret et le nom de fichier spécifiés. Vous devez disposer du rôle Maintainer ou Owner pour utiliser ce point de terminaison.

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

Attributs pris en charge :

Exemple de requête :

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

En cas de succès, renvoie le code de statut 204 sans corps de réponse.