Метки

Используйте REST API для управления метками для репозиториев, проблем и запросов на вытягивание.

Сведения о метках

С помощью REST API можно управлять метками для репозитория, а также добавлять или удалять метки для проблем и запросов на вытягивание. Каждый запрос на вытягивание является проблемой, но не каждая проблема является запросом на вытягивание. По этой причине "общие" действия для обеих функций, таких как управление назначенными, метками и вехами, предоставляются в конечных точках проблем.

List labels for an issue

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.
Query parameters
Имя, Type, Описание
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Описание
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone

Code samples

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.
Body parameters
Имя, Type, Описание
`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."

HTTP response status codes

Status code	Описание
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone
`422`	Validation failed, or the endpoint has been spammed.

Code samples

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

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

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

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.
Body parameters
Имя, Type, Описание
`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."

HTTP response status codes

Status code	Описание
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone
`422`	Validation failed, or the endpoint has been spammed.

Code samples

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

curl \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.

HTTP response status codes

Status code	Описание
`204`	No Content
`301`	Moved permanently
`404`	Resource not found
`410`	Gone

Code samples

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

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

Response

Status: 204

Remove a label from an issue

Works with 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.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.
`name`stringRequired

HTTP response status codes

Status code	Описание
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone

Code samples

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

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Query parameters
Имя, Type, Описание
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Описание
`200`	OK
`404`	Resource not found

Code samples

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Body parameters
Имя, Type, Описание
`name`stringRequired 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.

HTTP response status codes

Status code	Описание
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples

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

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`name`stringRequired

HTTP response status codes

Status code	Описание
`200`	OK
`404`	Resource not found

Code samples

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`name`stringRequired
Body parameters
Имя, Type, Описание
`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.

HTTP response status codes

Status code	Описание
`200`	OK

Code samples

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

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`name`stringRequired

HTTP response status codes

Status code	Описание
`204`	No Content

Code samples

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

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

Response

Status: 204

List labels for issues in a milestone

Works with GitHub Apps

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`milestone_number`integerRequired The number that identifies the milestone.
Query parameters
Имя, Type, Описание
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Описание
`200`	OK

Code samples

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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
  }
]