kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/labels.md
Robert Schilling 9284038dbe Add, delete labels via API
2014-08-13 12:28:19 +02:00

1.3 KiB
Raw Blame History

Labels

List labels

Get all labels for given project.

GET /projects/:id/labels

[
    {
        "name": "Awesome",
        "color": "#DD10AA"
    },
    {
        "name": "Documentation",
        "color": "#1E80DD"
    },
    {
        "name": "Feature",
        "color": "#11FF22"
    },
    {
        "name": "Bug",
        "color": "#EE1122"
    }
]

Create a new label

Creates a new label for given repository with given name and color.

POST /projects/:id/labels

Parameters:

  • id (required) - The ID of a project
  • name (required) - The name of the label
  • color (required) - Color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB)

It returns 200 and the newly created label, if the operation succeeds. If the label already exists, 409 and an error message is returned. If label parameters are invalid, 405 and an explaining error message is returned.

Delete a label

Deletes a label given by its name.

DELETE /projects/:id/labels
  • id (required) - The ID of a project
  • name (required) - The name of the label to be deleted

It returns 200 if the label successfully was deleted, 404 for wrong parameters and 400 if the label does not exist. In case of an error, additionally an error is returned.