We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.
リポジトリ Pre-receive フック
REST API を使用して、リポジトリで使用可能な pre-receive フックの適用を表示および変更します。
リポジトリの pre-receive フックについて
名前 | Type | 説明 |
---|---|---|
name | string | フックの名前。 |
enforcement | string | このリポジトリでのフックの適用状態。 |
configuration_url | string | 適用設定されているエンドポイントの URL。 |
適用に使用できる値は enabled
、disabled
とtesting
です。 disabled
は、pre-receive フックが実行されないことを示します。 enabled
は、それが実行され、ゼロ以外の状態になるプッシュを拒否することを示します。 testing
は、スクリプトは実行されるが、プッシュが拒否されないことを示します。
configuration_url
は、このリポジトリ、その Organization の所有者、またはグローバル設定へのリンクである場合があります。 configuration_url
のエンドポイントにアクセスする権限は、所有者またはサイト管理者レベルで決定されます。
List pre-receive hooks for a repository
List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
パラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept stringSetting to |
パス パラメーター |
名前, 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. |
クエリ パラメーター |
名前, Type, 説明 |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
direction stringThe direction to sort the results by. Default: 次のいずれかにできます: |
sort stringDefault: 次のいずれかにできます: |
HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
コード サンプル
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks
Response
Status: 200
[
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}
]
Get a pre-receive hook for a repository
パラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept stringSetting to |
パス パラメーター |
名前, 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. |
pre_receive_hook_id integer必須The unique identifier of the pre-receive hook. |
HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
コード サンプル
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
Response
Status: 200
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}
Update pre-receive hook enforcement for a repository
For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
パラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept stringSetting to |
パス パラメーター |
名前, 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. |
pre_receive_hook_id integer必須The unique identifier of the pre-receive hook. |
本文のパラメーター |
名前, Type, 説明 |
enforcement stringThe state of enforcement for the hook on this repository. 次のいずれかにできます: |
HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
コード サンプル
curl \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
-d '{"enforcement":"enabled"}'
Response
Status: 200
{
"id": 42,
"name": "Check Commits",
"enforcement": "enabled",
"configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42"
}
Remove pre-receive hook enforcement for a repository
Deletes any overridden enforcement on this repository for the specified hook.
Responds with effective values inherited from owner and/or global level.
パラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept stringSetting to |
パス パラメーター |
名前, 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. |
pre_receive_hook_id integer必須The unique identifier of the pre-receive hook. |
HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | Responds with effective values inherited from owner and/or global level. |
コード サンプル
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
Responds with effective values inherited from owner and/or global level.
Status: 200
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}