Etiquetas - GitHub Enterprise Server 3.1 Docs

About the Labels API

The Labels API supports managing labels for a repository and adding or removing labels to issues and pull requests. Cada solicitud de extracción es un informe de problemas, pero no todos los informes de problemas son una solicitud de extracción. For this reason, "shared" actions for both features, like managing assignees, labels, and milestones, are provided within Issues API.

List labels for an issue

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`issue_number`integerRequerido The number that identifies the issue.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`410`	Gone

Ejemplos de código

get/repos/{owner}/{repo}/issues/{issue_number}/labels

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/labels

Response

Status: 200

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  },
  {
    "id": 208045947,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
    "name": "enhancement",
    "description": "New feature or request",
    "color": "a2eeef",
    "default": false
  }
]

Add labels to an issue

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`issue_number`integerRequerido The number that identifies the issue.
Parámetros de cuerpo
Nombre, Tipo, Descripción
`labels`array of strings The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "Set labels for an issue."

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`410`	Gone
`422`	Validation failed

Ejemplos de código

post/repos/{owner}/{repo}/issues/{issue_number}/labels

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/labels \
  -d '{"labels":["bug","enhancement"]}'

Response

Status: 200

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  },
  {
    "id": 208045947,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
    "name": "enhancement",
    "description": "New feature or request",
    "color": "a2eeef",
    "default": false
  }
]

Set labels for an issue

Funciona con GitHub Apps

Removes any previous labels and sets the new labels for an issue.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`issue_number`integerRequerido The number that identifies the issue.
Parámetros de cuerpo
Nombre, Tipo, Descripción
`labels`array of strings The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "Add labels to an issue."

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`410`	Gone
`422`	Validation failed

Ejemplos de código

put/repos/{owner}/{repo}/issues/{issue_number}/labels

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/labels \
  -d '{"labels":["bug","enhancement"]}'

Response

Status: 200

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  },
  {
    "id": 208045947,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
    "name": "enhancement",
    "description": "New feature or request",
    "color": "a2eeef",
    "default": false
  }
]

Remove all labels from an issue

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`issue_number`integerRequerido The number that identifies the issue.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`204`	No Content
`410`	Gone

Ejemplos de código

delete/repos/{owner}/{repo}/issues/{issue_number}/labels

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/labels

Response

Status: 204

Remove a label from an issue

Funciona con GitHub Apps

Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`issue_number`integerRequerido The number that identifies the issue.
`name`stringRequerido

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`404`	Resource not found
`410`	Gone

Ejemplos de código

delete/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/labels/NAME

Response

Status: 200

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  }
]

List labels for a repository

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`404`	Resource not found

Ejemplos de código

get/repos/{owner}/{repo}/labels

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/labels

Response

Status: 200

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  },
  {
    "id": 208045947,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
    "name": "enhancement",
    "description": "New feature or request",
    "color": "a2eeef",
    "default": false
  }
]

Create a label

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
Parámetros de cuerpo
Nombre, Tipo, Descripción
`name`stringRequerido The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "Emoji cheat sheet."
`color`string The hexadecimal color code for the label, without the leading `#`.
`description`string A short description of the label. Must be 100 characters or fewer.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`201`	Created
`404`	Resource not found
`422`	Validation failed

Ejemplos de código

post/repos/{owner}/{repo}/labels

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/labels \
  -d '{"name":"bug","description":"Something isn't working","color":"f29513"}'

Response

Status: 201

{
  "id": 208045946,
  "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
  "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
  "name": "bug",
  "description": "Something isn't working",
  "color": "f29513",
  "default": true
}

Get a label

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`name`stringRequerido

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`404`	Resource not found

Ejemplos de código

get/repos/{owner}/{repo}/labels/{name}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/labels/NAME

Response

Status: 200

{
  "id": 208045946,
  "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
  "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
  "name": "bug",
  "description": "Something isn't working",
  "color": "f29513",
  "default": true
}

Update a label

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`name`stringRequerido
Parámetros de cuerpo
Nombre, Tipo, Descripción
`new_name`string The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "Emoji cheat sheet."
`color`string The hexadecimal color code for the label, without the leading `#`.
`description`string A short description of the label. Must be 100 characters or fewer.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

patch/repos/{owner}/{repo}/labels/{name}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/labels/NAME \
  -d '{"new_name":"bug :bug:","description":"Small bug fix required","color":"b01f26"}'

Response

Status: 200

{
  "id": 208045946,
  "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
  "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:",
  "name": "bug :bug:",
  "description": "Small bug fix required",
  "color": "b01f26",
  "default": true
}

Delete a label

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`name`stringRequerido

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`204`	No Content

Ejemplos de código

delete/repos/{owner}/{repo}/labels/{name}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/labels/NAME

Response

Status: 204

List labels for issues in a milestone

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`owner`stringRequerido The account owner of the repository. The name is not case sensitive.
`repo`stringRequerido The name of the repository. The name is not case sensitive.
`milestone_number`integerRequerido The number that identifies the milestone.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

get/repos/{owner}/{repo}/milestones/{milestone_number}/labels

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/milestones/MILESTONE_NUMBER/labels

Response

Status: 200

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  },
  {
    "id": 208045947,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
    "name": "enhancement",
    "description": "New feature or request",
    "color": "a2eeef",
    "default": false
  }
]