레이블

REST API를 사용하여 리포지토리, 문제 및 끌어오기 요청에 대한 레이블을 관리합니다.

레이블 정보

REST API를 사용하여 리포지토리에 대한 레이블을 관리하고 문제 및 끌어오기 요청에 레이블을 추가하거나 제거할 수 있습니다. 모든 끌어오기 요청은 문제이지만 모든 문제가 끌어오기 요청인 것은 아닙니다. 이러한 이유로 담당자, 레이블 및 마일스톤 관리와 같은 두 기능에 대한 "공유" 작업이 문제 엔드포인트 내에 제공됩니다.

List labels for an issue

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`issue_number`integer필수 The number that identifies the issue.
쿼리 매개 변수
Name, Type, 설명
`per_page`integer The number of results per page (max 100). 기본값: `30`
`page`integer Page number of the results to fetch. 기본값: `1`

HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`issue_number`integer필수 The number that identifies the issue.
본문 매개 변수
Name, 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 응답 상태 코드

상태 코드	Description
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone
`422`	Validation failed, or the endpoint has been spammed.

코드 샘플

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

에서 작동 GitHub Apps

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

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`issue_number`integer필수 The number that identifies the issue.
본문 매개 변수
Name, 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 응답 상태 코드

상태 코드	Description
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone
`422`	Validation failed, or the endpoint has been spammed.

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`issue_number`integer필수 The number that identifies the issue.

HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content
`301`	Moved permanently
`404`	Resource not found
`410`	Gone

코드 샘플

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

에서 작동 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.

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`issue_number`integer필수 The number that identifies the issue.
`name`string필수

HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`301`	Moved permanently
`404`	Resource not found
`410`	Gone

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
쿼리 매개 변수
Name, Type, 설명
`per_page`integer The number of results per page (max 100). 기본값: `30`
`page`integer Page number of the results to fetch. 기본값: `1`

HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`404`	Resource not found

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
본문 매개 변수
Name, Type, 설명
`name`string필수 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 응답 상태 코드

상태 코드	Description
`201`	Created
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`name`string필수

HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`404`	Resource not found

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`name`string필수
본문 매개 변수
Name, 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 응답 상태 코드

상태 코드	Description
`200`	OK

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`name`string필수

HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content

코드 샘플

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

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
`accept`string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, Type, 설명
`owner`string필수 The account owner of the repository. The name is not case sensitive.
`repo`string필수 The name of the repository. The name is not case sensitive.
`milestone_number`integer필수 The number that identifies the milestone.
쿼리 매개 변수
Name, Type, 설명
`per_page`integer The number of results per page (max 100). 기본값: `30`
`page`integer Page number of the results to fetch. 기본값: `1`

HTTP 응답 상태 코드

상태 코드	Description
`200`	OK

코드 샘플

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
  }
]