Labels

List labels

Get all labels for a given project.

GET /projects/:id/labels
Attribute Type Required Description
id integer yes The ID of the project
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/1/labels

Example response:

[
   {
      "name" : "bug",
      "color" : "#d9534f"
   },
   {
      "color" : "#d9534f",
      "name" : "confirmed"
   },
   {
      "name" : "critical",
      "color" : "#d9534f"
   },
   {
      "color" : "#428bca",
      "name" : "discussion"
   },
   {
      "name" : "documentation",
      "color" : "#f0ad4e"
   },
   {
      "color" : "#5cb85c",
      "name" : "enhancement"
   },
   {
      "color" : "#428bca",
      "name" : "suggestion"
   },
   {
      "color" : "#f0ad4e",
      "name" : "support"
   }
]

Create a new label

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

It returns 200 if the label was successfully created, 400 for wrong parameters and 409 if the label already exists.

POST /projects/:id/labels
Attribute Type Required Description
id integer yes The ID of the project
name string yes The name of the label
color string yes The color of the label in 6-digit hex notation with leading # sign
curl --data "name=feature&color=#5843AD" -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/labels"

Example response:

{
   "name" : "feature",
   "color" : "#5843AD"
}

Delete a label

Deletes a label with a given name.

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

DELETE /projects/:id/labels
Attribute Type Required Description
id integer yes The ID of the project
name string yes The name of the label
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/labels?name=bug"

Example response:

{
   "title" : "feature",
   "color" : "#5843AD",
   "updated_at" : "2015-11-03T21:22:30.737Z",
   "template" : false,
   "project_id" : 1,
   "created_at" : "2015-11-03T21:22:30.737Z",
   "id" : 9
}

Edit an existing label

Updates an existing label with new name or new color. At least one parameter is required, to update the label.

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

PUT /projects/:id/labels
Attribute Type Required Description
id integer yes The ID of the project
name string yes The name of the existing label
new_name string yes if color if not provided The new name of the label
color string yes if new_name is not provided The new color of the label in 6-digit hex notation with leading # sign
curl -X PUT --data "name=documentation&new_name=docs&color=#8E44AD" -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/labels"

Example response:

{
   "color" : "#8E44AD",
   "name" : "docs"
}