カスタムプロパティの REST API エンドポイント

REST API を使用して、組織によってリポジトリに割り当てられたカスタムプロパティを一覧表示します。

カスタムプロパティについて

REST API を使用して、リポジトリを所有する組織によってリポジトリに割り当てられたカスタムプロパティを表示できます。詳しくは、「Organization 内リポジトリのカスタムプロパティの管理」をご覧ください。カスタムプロパティを管理するための REST API エンドポイントの詳細については、「カスタムプロパティの REST API エンドポイント」を参照してください。

Get all custom property values for a repository

Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Metadata" repository permissions (read)

allows_public_read_access

"Get all custom property values for a repository" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository without the `.git` extension. The name is not case sensitive.

http_status_code

status_code	説明
`200`	OK
`403`	Forbidden
`404`	Resource not found

code_samples

request_example

get/repos/{owner}/{repo}/properties/values

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/properties/values

Response

Status: 200

[
  {
    "property_name": "environment",
    "value": "production"
  },
  {
    "property_name": "service",
    "value": "web"
  },
  {
    "property_name": "team",
    "value": "octocat"
  }
]

Create or update custom property values for a repository

Create new or update existing custom property values for a repository. Using a value of null for a custom property will remove or 'unset' the property value from the repository.

Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Custom properties" repository permissions (write)

"Create or update custom property values for a repository" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository without the `.git` extension. The name is not case sensitive.

名前, タイプ, 説明

properties array of objects 必須

A list of custom property names and associated values to apply to the repositories.

Properties of properties

名前, タイプ, 説明
`property_name` string 必須 The name of the property
`value` null or string or array 必須 The value assigned to the property

http_status_code

status_code	説明
`204`	No Content when custom property values are successfully created or updated
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

code_samples

request_example

patch/repos/{owner}/{repo}/properties/values

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/properties/values \
  -d '{"properties":[{"property_name":"environment","value":"production"},{"property_name":"service","value":"web"},{"property_name":"team","value":"octocat"}]}'

No Content when custom property values are successfully created or updated

Status: 204

カスタム プロパティの REST API エンドポイント

request_example

Response

request_example

No Content when custom property values are successfully created or updated

カスタムプロパティの REST API エンドポイント